Merge pull request #95 from algorandfoundation/update-langspec

boblat · web-flow · commit 45511a946ad8 · 2025-09-23T16:45:36.000+07:00
feat: update langspec to v4.3.0
diff --git a/docs/coverage.md b/docs/coverage.md
@@ -151,3 +151,4 @@ See which `algorand-typescript` stubs are implemented by the `algorand-typescrip
 | op.sqrt                      | Native              |
 | op.substring                 | Native              |
 | op.vrfVerify                 | Mockable            |
+| op.falconVerify              | Mockable            |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -68,8 +68,8 @@
     "vitest": "3.2.4"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.83",
-    "@algorandfoundation/puya-ts": "1.0.0-alpha.83",
+    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.84",
+    "@algorandfoundation/puya-ts": "1.0.0-alpha.84",
     "elliptic": "^6.6.1",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",
diff --git a/src/impl/app-params.ts b/src/impl/app-params.ts
@@ -71,4 +71,8 @@ export const AppParams: typeof op.AppParams = {
     const app = getApp(a)
     return app === undefined ? [Account(), false] : [app.address, true]
   },
+  appVersion: function (a: ApplicationType | uint64): readonly [uint64, boolean] {
+    const app = getApp(a)
+    return app === undefined ? [Uint64(0), false] : [app.version, true]
+  },
 }
diff --git a/src/impl/crypto.ts b/src/impl/crypto.ts
@@ -147,6 +147,11 @@ export const mimc = (_c: MimcConfigurations, _a: StubBytesCompat): bytes => {
   throw new NotImplementedError('mimc')
 }
 
+/** @internal */
+export const falconVerify = (_a: StubBytesCompat, _b: StubBytesCompat, _c: StubBytesCompat): boolean => {
+  throw new NotImplementedError('falconVerify')
+}
+
 const curveMap = {
   [Ecdsa.Secp256k1]: 'secp256k1',
   [Ecdsa.Secp256r1]: 'p256',
diff --git a/src/impl/gtxn.ts b/src/impl/gtxn.ts
@@ -197,7 +197,7 @@ export const GTxn: typeof op.GTxn = {
   lastLog(t: StubUint64Compat): bytes {
     return lazyContext.activeGroup.getApplicationCallTransaction(asUint64(t)).lastLog
   },
-  stateProofPk(t: StubUint64Compat): bytes {
+  stateProofPk(t: StubUint64Compat): bytes<64> {
     return lazyContext.activeGroup.getKeyRegistrationTransaction(asUint64(t)).stateProofKey
   },
   approvalProgramPages(a: StubUint64Compat, b: StubUint64Compat): bytes {
@@ -212,6 +212,9 @@ export const GTxn: typeof op.GTxn = {
   numClearStateProgramPages(t: StubUint64Compat): uint64 {
     return lazyContext.activeGroup.getApplicationCallTransaction(asUint64(t)).numClearStateProgramPages
   },
+  rejectVersion: function (a: uint64): uint64 {
+    return lazyContext.activeGroup.getApplicationCallTransaction(asUint64(a)).rejectVersion
+  },
 }
 
 /** @internal */
diff --git a/src/impl/itxn.ts b/src/impl/itxn.ts
@@ -243,7 +243,7 @@ export const GITxn: typeof op.GITxn = {
   lastLog: function (t: StubUint64Compat): bytes {
     return getApplicationCallInnerTxn(t).lastLog
   },
-  stateProofPk: function (t: StubUint64Compat): bytes {
+  stateProofPk: function (t: StubUint64Compat): bytes<64> {
     return getKeyRegistrationInnerTxn(t).stateProofKey
   },
   approvalProgramPages: function (t: StubUint64Compat, a: StubUint64Compat): bytes {
@@ -258,6 +258,9 @@ export const GITxn: typeof op.GITxn = {
   numClearStateProgramPages: function (t: StubUint64Compat): uint64 {
     return getApplicationCallInnerTxn(t).numClearStateProgramPages
   },
+  rejectVersion: function (t: StubUint64Compat): uint64 {
+    return getApplicationCallInnerTxn(t).rejectVersion
+  },
 }
 /** @internal */
 export const ITxn: typeof op.ITxn = {
@@ -643,7 +646,7 @@ export const ITxn: typeof op.ITxn = {
   /**
    * 64 byte state proof public key
    */
-  get stateProofPk(): bytes {
+  get stateProofPk(): bytes<64> {
     return lazyContext.activeGroup.getItxnGroup().getKeyRegistrationInnerTxn().stateProofKey
   },
   /**
@@ -670,6 +673,9 @@ export const ITxn: typeof op.ITxn = {
   get numClearStateProgramPages(): uint64 {
     return lazyContext.activeGroup.getItxnGroup().getApplicationCallInnerTxn().numClearStateProgramPages
   },
+  get rejectVersion(): uint64 {
+    return lazyContext.activeGroup.getItxnGroup().getApplicationCallInnerTxn().rejectVersion
+  },
 }
 
 const setConstructingItxnField = (fields: Partial<InnerTxnFields>): void => {
@@ -862,6 +868,9 @@ export const ITxnCreate: typeof op.ITxnCreate = {
     pages.push(asBytes(a))
     setConstructingItxnField({ clearStateProgram: pages })
   },
+  setRejectVersion: function (a: StubUint64Compat): void {
+    setConstructingItxnField({ rejectVersion: asUint64(a) })
+  },
   next: function (): void {
     lazyContext.activeGroup.appendInnerTransactionGroup()
   },
diff --git a/src/impl/reference.ts b/src/impl/reference.ts
@@ -168,6 +168,7 @@ export class ApplicationData {
       localStateMaps: new BytesMap(),
       boxes: new BytesMap(),
       materialisedBoxes: new BytesMap(),
+      version: 0,
     }
   }
 }
@@ -221,6 +222,9 @@ export class ApplicationCls extends Uint64BackedCls implements ApplicationType {
     }
     return result
   }
+  get version(): uint64 {
+    return this.data.application.version
+  }
 }
 
 export type AssetData = Mutable<Omit<AssetType, 'id' | 'balance' | 'frozen'>>
diff --git a/src/impl/transactions.ts b/src/impl/transactions.ts
@@ -253,6 +253,7 @@ export class ApplicationCallTransaction extends TransactionBase implements gtxn.
   #clearStateProgramPages: Array<bytes>
   #appLogs: Array<bytes>
   #appId: ApplicationType
+  #rejectVersion: uint64
 
   /** @internal */
   protected constructor(fields: ApplicationCallTransactionFields) {
@@ -272,6 +273,7 @@ export class ApplicationCallTransaction extends TransactionBase implements gtxn.
     this.#apps = fields.apps ?? []
     this.#approvalProgramPages = fields.approvalProgramPages ?? (fields.approvalProgram ? [fields.approvalProgram] : [])
     this.#clearStateProgramPages = fields.clearStateProgramPages ?? (fields.clearStateProgram ? [fields.clearStateProgram] : [])
+    this.#rejectVersion = fields.rejectVersion ?? Uint64(0)
     Object.entries(fields.scratchSpace ?? {}).forEach(([k, v]) => this.setScratchSlot(Number(k), v))
   }
 
@@ -335,6 +337,9 @@ export class ApplicationCallTransaction extends TransactionBase implements gtxn.
   get apfa() {
     return this.#apps
   }
+  get rejectVersion() {
+    return this.#rejectVersion
+  }
   appArgs(index: Uint64Compat): bytes {
     return toBytes(this.args[asNumber(index)])
   }
diff --git a/src/impl/txn.ts b/src/impl/txn.ts
@@ -462,7 +462,7 @@ export const Txn: typeof op.Txn = {
   /**
    * 64 byte state proof public key
    */
-  get stateProofPk(): bytes {
+  get stateProofPk(): bytes<64> {
     return lazyContext.activeGroup.getKeyRegistrationTransaction().stateProofKey
   },
 
@@ -493,4 +493,7 @@ export const Txn: typeof op.Txn = {
   get numClearStateProgramPages(): uint64 {
     return lazyContext.activeGroup.getApplicationCallTransaction().numClearStateProgramPages
   },
+  get rejectVersion(): uint64 {
+    return lazyContext.activeGroup.getApplicationCallTransaction().rejectVersion
+  },
 }
diff --git a/src/internal/op.ts b/src/internal/op.ts
@@ -24,6 +24,7 @@ export {
   ed25519verify,
   ed25519verifyBare,
   EllipticCurve,
+  falconVerify,
   keccak256,
   mimc,
   sha256,
diff --git a/tests/artifacts/avm12/contract.algo.ts b/tests/artifacts/avm12/contract.algo.ts
@@ -0,0 +1,63 @@
+import {
+  abimethod,
+  arc4,
+  assert,
+  Bytes,
+  contract,
+  Contract,
+  itxn,
+  OnCompleteAction,
+  op,
+  Txn,
+} from '@algorandfoundation/algorand-typescript'
+
+@contract({ avmVersion: 12 })
+export class Avm12Contract extends Contract {
+  testFalconVerify() {
+    assert(!op.falconVerify(Bytes(), Bytes(), op.bzero(1793).toFixed({ length: 1793 })))
+  }
+
+  testRejectVersion() {
+    const compiledV0 = arc4.compileArc4(ContractV0)
+    const v0Txn = compiledV0.bareCreate()
+    const app = v0Txn.createdApp
+    assert(app.version === 0, 'should be version 0')
+
+    const compiledV1 = arc4.compileArc4(ContractV1)
+
+    const v1Txn = compiledV0.call.update({
+      rejectVersion: 1,
+      appId: app,
+      onCompletion: OnCompleteAction.UpdateApplication,
+      approvalProgram: compiledV1.approvalProgram,
+      clearStateProgram: compiledV1.clearStateProgram,
+      extraProgramPages: compiledV1.extraProgramPages,
+    })
+    assert(v1Txn.itxn.appId.version === 1, 'should be version 1')
+
+    itxn
+      .applicationCall({
+        appArgs: [arc4.methodSelector(ContractV1.prototype.delete)],
+        onCompletion: OnCompleteAction.DeleteApplication,
+        appId: app,
+        rejectVersion: 2,
+      })
+      .submit()
+  }
+}
+
+@contract({ avmVersion: 12 })
+export class ContractV0 extends Contract {
+  @abimethod({ allowActions: 'UpdateApplication' })
+  update() {
+    assert(Txn.rejectVersion === 1, 'can only update if caller expects this to be currently be v0')
+  }
+}
+
+@contract({ avmVersion: 12 })
+export class ContractV1 extends Contract {
+  @abimethod({ allowActions: 'DeleteApplication' })
+  delete() {
+    assert(Txn.rejectVersion === 2, 'can only update if caller expects this to be currently be v1')
+  }
+}
diff --git a/tests/avm12.algo.spec.ts b/tests/avm12.algo.spec.ts
@@ -0,0 +1,49 @@
+import { algos } from '@algorandfoundation/algokit-utils'
+import { ApplicationSpy, TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
+import { afterEach, beforeAll, describe, expect } from 'vitest'
+import { Avm12Contract, ContractV0, ContractV1 } from './artifacts/avm12/contract.algo'
+import { createArc4TestFixture } from './test-fixture'
+
+describe('avm12', () => {
+  const [test, localnetFixture] = createArc4TestFixture('tests/artifacts/avm12/contract.algo.ts', {
+    Avm12Contract: { funding: algos(1) },
+  })
+
+  const ctx = new TestExecutionContext()
+  beforeAll(async () => {
+    await localnetFixture.newScope()
+  })
+  afterEach(() => {
+    ctx.reset()
+  })
+
+  test('reject wrong app version', async ({ appClientAvm12Contract }) => {
+    await appClientAvm12Contract.send.call({ method: 'testRejectVersion', args: [], extraFee: algos(1) })
+    const itxnComposeAlgoContract = ctx.contract.create(Avm12Contract)
+
+    const contractV0App = ctx.any.application({
+      approvalProgram: ctx.any.bytes(),
+    })
+    ctx.setCompiledApp(ContractV0, contractV0App.id)
+
+    const spyV0 = new ApplicationSpy(ContractV0)
+    spyV0.onBareCall((itxnContext) => {
+      if (itxnContext.approvalProgram === contractV0App.approvalProgram) {
+        itxnContext.createdApp = contractV0App
+      }
+    })
+    spyV0.on.update((itxnContext) => {
+      if (itxnContext.appId === contractV0App) {
+        ctx.ledger.patchApplicationData(itxnContext.appId, { application: { version: 1 } })
+      }
+    })
+
+    const spyV1 = new ApplicationSpy(ContractV1)
+    spyV1.on.delete((itxnContext) => {
+      expect(itxnContext.rejectVersion).toEqual(2)
+    })
+    ctx.addApplicationSpy(spyV0)
+    ctx.addApplicationSpy(spyV1)
+    itxnComposeAlgoContract.testRejectVersion()
+  })
+})
diff --git a/tests/crypto-op-codes.algo.spec.ts b/tests/crypto-op-codes.algo.spec.ts
@@ -30,6 +30,7 @@ vi.mock('../src/impl/crypto', async (importOriginal) => {
     ...mod,
     vrfVerify: vi.fn(mod.vrfVerify),
     mimc: vi.fn(mod.mimc),
+    falconVerify: vi.fn(mod.falconVerify),
   }
 })
 
@@ -362,6 +363,27 @@ describe('crypto op codes', async () => {
       )
     })
   })
+
+  describe('falconVerify', async () => {
+    const a = Bytes.fromHex('528b9e23d93d0e020a119d7ba213f6beb1c1f3495a217166ecd20f5a70e7c2d7')
+    const b = op.bzero(1232).toFixed({ length: 1232 })
+
+    const c = op.bzero(1793).toFixed({ length: 1793 })
+
+    test('should throw not available error', async () => {
+      const mockedFalconVerify = op.falconVerify as Mock<typeof op.falconVerify>
+      // restore to original stub implemention which should throw not available error
+      mockedFalconVerify.mockRestore()
+      expect(() => op.falconVerify(a, b, c)).toThrow('falconVerify is not available in test context')
+    })
+
+    test('should return mocked result', () => {
+      const mockedFalconVerify = op.falconVerify as Mock<typeof op.falconVerify>
+      mockedFalconVerify.mockReturnValue(true)
+      const result = op.falconVerify(a, b, c)
+      expect(result).toBe(true)
+    })
+  })
 })
 
 const generateEcdsaTestData = (v: Ecdsa) => {

Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,8 @@ export const AppParams: typeof op.AppParams = {`
`71`	`71`	`const app = getApp(a)`
`72`	`72`	`return app === undefined ? [Account(), false] : [app.address, true]`
`73`	`73`	`},`
	`74`	`+ appVersion: function (a: ApplicationType \| uint64): readonly [uint64, boolean] {`
	`75`	`+ const app = getApp(a)`
	`76`	`+ return app === undefined ? [Uint64(0), false] : [app.version, true]`
	`77`	`+ },`
`74`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,7 @@ export class ApplicationData {`
`168`	`168`	`localStateMaps: new BytesMap(),`
`169`	`169`	`boxes: new BytesMap(),`
`170`	`170`	`materialisedBoxes: new BytesMap(),`
	`171`	`+ version: 0,`
`171`	`172`	`}`
`172`	`173`	`}`
`173`	`174`	`}`
`@@ -221,6 +222,9 @@ export class ApplicationCls extends Uint64BackedCls implements ApplicationType {`
`221`	`222`	`}`
`222`	`223`	`return result`
`223`	`224`	`}`
	`225`	`+ get version(): uint64 {`
	`226`	`+ return this.data.application.version`
	`227`	`+ }`
`224`	`228`	`}`
`225`	`229`
`226`	`230`	`export type AssetData = Mutable<Omit<AssetType, 'id' \| 'balance' \| 'frozen'>>`