Merge pull request #36 from algorandfoundation/fix-reference-types

fix: use correct types for account reference arguments

.github/workflows/pr.yml

@@ -15,6 +15,7 @@ jobs:
     with:
       run-commit-lint: true
       run-build: true
+      audit-script: npm run audit
       pre-test-script: |
         pipx install algokit
         algokit localnet start

.nsprc

@@ -0,0 +1,7 @@
+{
+  "GHSA-c2qf-rxjj-qqgw": {
+    "active": true,
+    "notes": "Ignored while dependencies are patching",
+    "expiry": "2023-06-30"
+  }
+}

examples/state/client.spec.ts

@@ -140,7 +140,7 @@ describe('state typed client', () => {
     expect(localState.local_bytes1?.asString()).toBe('default value')
   })
 
-  test('ABI methods which take assets can be called', async () => {
+  test('ABI methods which take references can be called', async () => {
     const { algod, indexer, testAccount } = localnet.context
     const client = new StateAppClient(
       {
@@ -154,8 +154,10 @@ describe('state typed client', () => {
     await client.deploy({ deployTimeParams: { VALUE: 1 } })
 
     // Call with number
-    await client.callWithAsset({ asset: 1234 })
-    // Call with bigint
-    await client.callWithAsset({ asset: 1234n })
+    await client.callWithReferences({
+      asset: 1234,
+      account: testAccount.addr,
+      application: (await client.appClient.getAppReference()).appId,
+    })
   })
 })

examples/state/state.py

@@ -56,10 +56,18 @@ def call_abi_txn(txn: pt.abi.PaymentTransaction, value: pt.abi.String, *, output
     )
 
 @app.external()
-def call_with_asset(asset: pt.abi.Asset, *, output: pt.abi.Uint64) -> pt.Expr:
+def call_with_references(
+    asset: pt.abi.Asset,
+    account: pt.abi.Account,
+    application: pt.abi.Application,
+    *,
+    output: pt.abi.Uint64
+) -> pt.Expr:
     return pt.Seq(
         pt.Assert(asset.asset_id(), comment="asset not provided"),
-        output.set(asset.asset_id()),
+        pt.Assert(pt.Len(account.address()), comment="account not provided"),
+        pt.Assert(application.application_id(), comment="application not provided"),
+        output.set(pt.Int(1)),
     )
 
 @app.external()

package.json

@@ -5,6 +5,7 @@
   "main": "src/index.js",
   "private": false,
   "scripts": {
+    "audit": "better-npm-audit audit",
     "dev": "run-s dev:*",
     "dev:helloworld": "ts-node --transpile-only src/index.ts generate -a ./examples/helloworld/application.json -o ./examples/helloworld/client.generated.ts",
     "dev:lifecycle": "ts-node --transpile-only src/index.ts generate -a ./examples/lifecycle/application.json -o ./examples/lifecycle/client.generated.ts",
@@ -50,6 +51,7 @@
     "@noble/ed25519": "1.7.3",
     "@types/jest": "^29.5.2",
     "algosdk": "^2.3.0",
+    "better-npm-audit": "^3.7.3",
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "copyfiles": "^2.4.1",
     "eslint": "8.42.0",

src/client/helpers/get-equivalent-type.ts

@@ -4,12 +4,12 @@ import {
   ABIArrayStaticType,
   ABIBoolType,
   ABIByteType,
+  ABIReferenceType,
   ABIStringType,
   ABITupleType,
   ABIType,
   ABIUfixedType,
   ABIUintType,
-  abiTypeIsReference,
   abiTypeIsTransaction,
 } from 'algosdk'
 
@@ -20,7 +20,10 @@ export function getEquivalentType(abiTypeStr: string, ioType: 'input' | 'output'
   if (abiTypeIsTransaction(abiTypeStr)) {
     return 'TransactionToSign | Transaction | Promise<SendTransactionResult>'
   }
-  if (abiTypeIsReference(abiTypeStr)) {
+  if (abiTypeStr == ABIReferenceType.account) {
+    return 'string | Uint8Array'
+  }
+  if (abiTypeStr == ABIReferenceType.application || abiTypeStr == ABIReferenceType.asset) {
     return 'number | bigint'
   }