Merge pull request #93 from algorandfoundation/feat/replace-box-ref

feat: make BoxRef methods directly accessible on Box class

Author: boblat

docs/coverage.md

@@ -15,7 +15,6 @@ See which `algorand-typescript` stubs are implemented by the `algorand-typescrip
 | BigUint                      | Native              |
 | Box                          | Emulated            |
 | BoxMap                       | Emulated            |
-| BoxRef                       | Emulated            |
 | Bytes                        | Native              |
 | CompiledContract             | Mockable            |
 | CompiledLogicSig             | Mockable            |

examples/proof-of-attendance/contract.algo.ts

@@ -4,7 +4,6 @@ import {
   assert,
   Box,
   BoxMap,
-  BoxRef,
   Bytes,
   ensureBudget,
   Global,
@@ -63,11 +62,11 @@ export default class ProofOfAttendance extends arc4.Contract {
     const mintedAsset = this.mintPoa(Txn.sender)
     this.totalAttendees.value += 1
 
-    const boxRef = BoxRef({ key: Txn.sender.bytes })
+    const boxRef = Box<bytes>({ key: Txn.sender.bytes })
     const hasClaimed = boxRef.exists
     assert(!hasClaimed, 'Already claimed POA')
 
-    boxRef.put(op.itob(mintedAsset.id))
+    boxRef.value = op.itob(mintedAsset.id)
   }
 
   @arc4.abimethod()
@@ -99,7 +98,7 @@ export default class ProofOfAttendance extends arc4.Contract {
 
   @readonly
   getPoaIdWithBoxRef(): uint64 {
-    const boxRef = BoxRef({ key: Txn.sender.bytes })
+    const boxRef = Box<bytes>({ key: Txn.sender.bytes })
     const [poaId, exists] = boxRef.maybe()
     assert(exists, 'POA not found')
     return op.btoi(poaId)
@@ -153,7 +152,7 @@ export default class ProofOfAttendance extends arc4.Contract {
 
   @arc4.abimethod()
   claimPoaWithBoxRef(optInTxn: gtxn.AssetTransferTxn) {
-    const boxRef = BoxRef({ key: Txn.sender.bytes })
+    const boxRef = Box<bytes>({ key: Txn.sender.bytes })
     const [poaId, exists] = boxRef.maybe()
     assert(exists, 'POA not found, attendance validation failed!')
     assert(optInTxn.xferAsset.id === op.btoi(poaId), 'POA ID mismatch')

examples/simple-voting/contract.algo.spec.ts

@@ -31,7 +31,7 @@ describe('Simple voting contract', () => {
           .execute(contract.approvalProgram)
 
         expect(result).toEqual(1)
-        expect(contract.topic.value).toBe(topic)
+        expect(contract.topic.value).toEqual(topic)
       })
     })
   })

examples/voting/contract.algo.ts

@@ -4,8 +4,8 @@ import {
   arc4,
   assert,
   assertMatch,
+  Box,
   BoxMap,
-  BoxRef,
   Bytes,
   clone,
   ensureBudget,
@@ -46,7 +46,7 @@ export class VotingRoundApp extends arc4.Contract {
   isBootstrapped = GlobalState<boolean>({ initialValue: false })
   voterCount = GlobalState({ initialValue: Uint64(0) })
   closeTime = GlobalState<uint64>()
-  tallyBox = BoxRef({ key: Bytes`V` })
+  tallyBox = Box<bytes>({ key: Bytes`V` })
   votesByAccount = BoxMap<Account, VoteIndexArray>({ keyPrefix: Bytes() })
   voteId = GlobalState<string>()
   snapshotPublicKey = GlobalState<bytes<32>>()

package-lock.json

@@ -68,8 +68,8 @@
     "vitest": "3.2.4"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.81",
-    "@algorandfoundation/puya-ts": "1.0.0-alpha.81",
+    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.82",
+    "@algorandfoundation/puya-ts": "1.0.0-alpha.82",
     "elliptic": "^6.6.1",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",

package.json

@@ -2,7 +2,7 @@ import type { bytes, op, uint64 } from '@algorandfoundation/algorand-typescript'
 import { MAX_BOX_SIZE } from '../constants'
 import { lazyContext } from '../context-helpers/internal-context'
 import { AvmError, InternalError } from '../errors'
-import { asBytes, asBytesCls, asNumber, asUint8Array, conactUint8Arrays } from '../util'
+import { asBytes, asBytesCls, asNumber, asUint8Array, concatUint8Arrays } from '../util'
 import { toBytes } from './encoded-types'
 import type { StubBytesCompat, StubUint64Compat } from './primitives'
 
@@ -79,7 +79,7 @@ export const Box: typeof op.Box = {
     if (start + newContent.length > boxContent.length) {
       throw new InternalError('Replacement content exceeds box size')
     }
-    const updatedContent = conactUint8Arrays(boxContent.slice(0, start), newContent, boxContent.slice(start + newContent.length))
+    const updatedContent = concatUint8Arrays(boxContent.slice(0, start), newContent, boxContent.slice(start + newContent.length))
     lazyContext.ledger.setBox(app, name, updatedContent)
   },
   resize(a: StubBytesCompat, b: StubUint64Compat): void {
@@ -93,7 +93,7 @@ export const Box: typeof op.Box = {
     const size = boxContent.length
     let updatedContent
     if (newSize > size) {
-      updatedContent = conactUint8Arrays(boxContent, new Uint8Array(newSize - size))
+      updatedContent = concatUint8Arrays(boxContent, new Uint8Array(newSize - size))
     } else {
       updatedContent = boxContent.slice(0, newSize)
     }
@@ -114,12 +114,12 @@ export const Box: typeof op.Box = {
       throw new InternalError('Start index exceeds box size')
     }
     const end = Math.min(start + length, size)
-    let updatedContent = conactUint8Arrays(boxContent.slice(0, start), newContent, boxContent.slice(end))
+    let updatedContent = concatUint8Arrays(boxContent.slice(0, start), newContent, boxContent.slice(end))
     //  Adjust the size if necessary
     if (updatedContent.length > size) {
       updatedContent = updatedContent.slice(0, size)
     } else if (updatedContent.length < size) {
-      updatedContent = conactUint8Arrays(updatedContent, new Uint8Array(size - asNumber(updatedContent.length)))
+      updatedContent = concatUint8Arrays(updatedContent, new Uint8Array(size - asNumber(updatedContent.length)))
     }
     lazyContext.ledger.setBox(app, name, updatedContent)
   },

src/impl/box.ts

@@ -8,7 +8,7 @@ import nacl from 'tweetnacl'
 import { LOGIC_DATA_PREFIX, PROGRAM_TAG } from '../constants'
 import { lazyContext } from '../context-helpers/internal-context'
 import { InternalError, NotImplementedError } from '../errors'
-import { asBytes, asBytesCls, asUint8Array, conactUint8Arrays } from '../util'
+import { asBytes, asBytesCls, asUint8Array, concatUint8Arrays } from '../util'
 import type { StubBytesCompat, StubUint64Compat } from './primitives'
 import { Bytes, BytesCls, FixedBytes, Uint64Cls } from './primitives'
 
@@ -57,7 +57,7 @@ export const ed25519verify = (a: StubBytesCompat, b: StubBytesCompat, c: StubByt
   const txn = lazyContext.activeGroup.activeTransaction as gtxn.ApplicationCallTxn
   const programBytes = asBytesCls(txn.onCompletion == OnCompleteAction.ClearState ? txn.clearStateProgram : txn.approvalProgram)
 
-  const logicSig = conactUint8Arrays(asUint8Array(PROGRAM_TAG), programBytes.asUint8Array())
+  const logicSig = concatUint8Arrays(asUint8Array(PROGRAM_TAG), programBytes.asUint8Array())
   const logicSigAddress = js_sha512.sha512_256.array(logicSig)
 
   const addressBytes = Bytes(logicSigAddress)