Merge pull request #66 from algorandfoundation/fix/box-mutation

fix: allow mutation of values stored in boxes, automatically register app address with context

Author: boblat

package-lock.json

@@ -67,7 +67,7 @@
   },
   "dependencies": {
     "@algorandfoundation/algorand-typescript": "^1.0.0-beta.25",
-    "@algorandfoundation/puya-ts": "^1.0.0-beta.43",
+    "@algorandfoundation/puya-ts": "^1.0.0-beta.46",
     "elliptic": "^6.5.7",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",

package.json

@@ -22,7 +22,7 @@ import {
 } from '../constants'
 import { lazyContext } from '../context-helpers/internal-context'
 import { AvmError, InternalError } from '../errors'
-import type { Mutable } from '../typescript-helpers'
+import type { DeliberateAny, Mutable } from '../typescript-helpers'
 import { asBigInt, asBytes, asUint64, asUint64Cls, asUint8Array, conactUint8Arrays } from '../util'
 import { BytesBackedCls, Uint64BackedCls } from './base'
 import type { StubUint64Compat } from './primitives'
@@ -136,6 +136,7 @@ export class ApplicationData {
     localStates: BytesMap<LocalState<unknown>>
     localStateMaps: BytesMap<AccountMap<LocalStateCls<unknown>>>
     boxes: BytesMap<Uint8Array>
+    materialisedBoxes: BytesMap<DeliberateAny>
   }
 
   isCreating: boolean = false
@@ -155,6 +156,7 @@ export class ApplicationData {
       localStates: new BytesMap(),
       localStateMaps: new BytesMap(),
       boxes: new BytesMap(),
+      materialisedBoxes: new BytesMap(),
     }
   }
 }
@@ -200,7 +202,11 @@ export class ApplicationCls extends Uint64BackedCls implements ApplicationType {
     return this.data.application.creator
   }
   get address(): AccountType {
-    return getApplicationAddress(this.id)
+    const result = getApplicationAddress(this.id)
+    if (!lazyContext.ledger.accountDataMap.has(result)) {
+      lazyContext.any.account({ address: result.bytes })
+    }
+    return result
   }
 }
 

src/impl/reference.ts

@@ -155,11 +155,18 @@ export class BoxCls<TValue> {
     if (!this.exists) {
       throw new InternalError('Box has not been created')
     }
-
-    return this.fromBytes(lazyContext.ledger.getBox(this.#app, this.key))
+    let materialised = lazyContext.ledger.getMaterialisedBox<TValue>(this.#app, this.key)
+    if (materialised !== undefined) {
+      return materialised
+    }
+    const original = lazyContext.ledger.getBox(this.#app, this.key)
+    materialised = this.fromBytes(original)
+    lazyContext.ledger.setMatrialisedBox(this.#app, this.key, materialised)
+    return materialised
   }
   set value(v: TValue) {
     lazyContext.ledger.setBox(this.#app, this.key, asUint8Array(toBytes(v)))
+    lazyContext.ledger.setMatrialisedBox(this.#app, this.key, v)
   }
 
   get hasKey(): boolean {

src/impl/state.ts

@@ -9,6 +9,7 @@ import type {
 } from '@algorandfoundation/algorand-typescript'
 import { AccountMap, Uint64Map } from '../collections/custom-key-map'
 import { MAX_UINT64 } from '../constants'
+import { toBytes } from '../encoders'
 import { InternalError } from '../errors'
 import { BlockData } from '../impl/block'
 import { GlobalData } from '../impl/global'
@@ -340,9 +341,26 @@ export class LedgerContext {
   getBox(app: ApplicationType | BaseContract, key: StubBytesCompat): Uint8Array {
     const appId = this.getAppId(app)
     const appData = this.applicationDataMap.getOrFail(appId)
+    const materialised = appData.application.materialisedBoxes.get(key)
+    if (materialised !== undefined) {
+      return asUint8Array(toBytes(materialised))
+    }
     return appData.application.boxes.get(key) ?? new Uint8Array()
   }
 
+  /**
+   * Retrieves a materialised box for an application by key.
+   * @internal
+   * @param app - The application.
+   * @param key - The key.
+   * @returns The materialised box data if exists or undefined.
+   */
+  getMaterialisedBox<T>(app: ApplicationType | BaseContract, key: StubBytesCompat): T | undefined {
+    const appId = this.getAppId(app)
+    const appData = this.applicationDataMap.getOrFail(appId)
+    return appData.application.materialisedBoxes.get(key) as T | undefined
+  }
+
   /**
    * Sets a box for an application by key.
    * @param app - The application.
@@ -354,6 +372,21 @@ export class LedgerContext {
     const appData = this.applicationDataMap.getOrFail(appId)
     const uint8ArrayValue = value instanceof Uint8Array ? value : asUint8Array(value)
     appData.application.boxes.set(key, uint8ArrayValue)
+    appData.application.materialisedBoxes.set(key, undefined)
+  }
+
+  /**
+
+ * Cache the materialised box for an application by key.
+* @internal
+ * @param app - The application.
+ * @param key - The key.
+ * @param value - The box data.
+ */
+  setMatrialisedBox<TValue>(app: ApplicationType | BaseContract, key: StubBytesCompat, value: TValue | undefined): void {
+    const appId = this.getAppId(app)
+    const appData = this.applicationDataMap.getOrFail(appId)
+    appData.application.materialisedBoxes.set(key, value)
   }
 
   /**
@@ -365,6 +398,7 @@ export class LedgerContext {
   deleteBox(app: ApplicationType | BaseContract, key: StubBytesCompat): boolean {
     const appId = this.getAppId(app)
     const appData = this.applicationDataMap.getOrFail(appId)
+    appData.application.materialisedBoxes.delete(key)
     return appData.application.boxes.delete(key)
   }
 

src/subcontexts/ledger-context.ts

@@ -2,7 +2,7 @@ import type { biguint, bytes, uint64 } from '@algorandfoundation/algorand-typesc
 import { BigUint, BoxMap, Bytes, op, Uint64 } from '@algorandfoundation/algorand-typescript'
 import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
 import { ARC4Encoded, DynamicArray, interpretAsArc4, Str, UintN64 } from '@algorandfoundation/algorand-typescript/arc4'
-import { afterEach, describe, expect, test } from 'vitest'
+import { afterEach, describe, expect, it, test } from 'vitest'
 import { MAX_UINT64 } from '../../src/constants'
 import { toBytes } from '../../src/encoders'
 import { asBytes } from '../../src/util'
@@ -204,4 +204,30 @@ describe('BoxMap', () => {
       }
     })
   })
+
+  it('can maintain the mutations to the array box value', () => {
+    ctx.txn.createScope([ctx.any.txn.applicationCall()]).execute(() => {
+      const boxMap = BoxMap<Str, DynamicArray<UintN64>>({ keyPrefix })
+      const key = new Str('jkl')
+      const value = new DynamicArray(new UintN64(100), new UintN64(200))
+      boxMap(key).value = value
+      expect(boxMap(key).value.length).toEqual(2)
+      expect(boxMap(key).value.at(-1).native).toEqual(200)
+
+      // newly pushed value should be retained
+      boxMap(key).value.push(new UintN64(300))
+      expect(boxMap(key).value.length).toEqual(3)
+      expect(boxMap(key).value.at(-1).native).toEqual(300)
+
+      // setting bytes value through op should be reflected in the box value.
+      const copy = boxMap(key).value.copy()
+      copy[2] = new UintN64(400)
+      expect(boxMap(key).value.at(-1).native).toEqual(300)
+
+      const fullKey = keyPrefix.concat(toBytes(key))
+      op.Box.put(fullKey, toBytes(copy))
+      expect(boxMap(key).value.length).toEqual(3)
+      expect(boxMap(key).value.at(-1).native).toEqual(400)
+    })
+  })
 })

tests/references/box-map.spec.ts

@@ -205,4 +205,28 @@ describe('Box', () => {
       }
     })
   })
+
+  it('can maintain the mutations to the box value', () => {
+    ctx.txn.createScope([ctx.any.txn.applicationCall()]).execute(() => {
+      const box = Box<DynamicArray<UintN64>>({ key })
+      const value = new DynamicArray(new UintN64(100), new UintN64(200))
+      box.value = value
+      expect(box.value.length).toEqual(2)
+      expect(box.value.at(-1).native).toEqual(200)
+
+      // newly pushed value should be retained
+      box.value.push(new UintN64(300))
+      expect(box.value.length).toEqual(3)
+      expect(box.value.at(-1).native).toEqual(300)
+
+      // setting bytes value through op should be reflected in the box value.
+      const copy = box.value.copy()
+      copy[2] = new UintN64(400)
+      expect(box.value.at(-1).native).toEqual(300)
+
+      op.Box.put(key, toBytes(copy))
+      expect(box.value.length).toEqual(3)
+      expect(box.value.at(-1).native).toEqual(400)
+    })
+  })
 })