Merge pull request #6 from algorandfoundation/feat-app-global

feat: implement AppGlobal and add tests for it

Author: boblat

.editorconfig

@@ -0,0 +1,9 @@
+[*]
+charset = utf-8
+insert_final_newline = true
+end_of_line = lf
+indent_style = space
+indent_size = 2
+tab_width = 2
+max_line_length = 140
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,6 @@
+# Set the repository to show as TypeScript rather than JS in GitHub
+*.js linguist-detectable=false
+
+# Treat text as lf
+* text=auto
+* eol=lf

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "explicit"
+  },
+  "eslint.validate": ["typescript"],
+  "eslint.options": {
+    "extensions": [".ts"]
+  },
+  "typescript.preferences.quoteStyle": "single",
+  "yaml.schemas": {
+    "https://json.schemastore.org/github-workflow.json": "/.github/workflows/*.yml",
+    "https://json.schemastore.org/github-action.json": "/.github/actions/**/*.yml"
+  },
+  "files.associations": {
+    "*.mdx": "markdown"
+  }
+}

package-lock.json

@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "@algorandfoundation/algokit-utils": "^6.2.1",
-    "@algorandfoundation/algorand-typescript": "^0.0.1-alpha.9",
+    "@algorandfoundation/algorand-typescript": "^0.0.1-alpha.12",
     "@algorandfoundation/puya-ts": "^1.0.0-alpha.14",
     "algosdk": "^2.9.0",
     "elliptic": "^6.5.7",

package.json

@@ -1,6 +1,6 @@
 import { Account, internal } from '@algorandfoundation/algorand-typescript'
-import { encodingUtil } from '@algorandfoundation/puya-ts'
 import { DeliberateAny } from '../typescript-helpers'
+import { asBytesCls, asUint64Cls } from '../util'
 
 type Primitive = number | bigint | string | boolean
 export abstract class CustomKeyMap<TKey, TValue> implements Map<TKey, TValue> {
@@ -25,6 +25,13 @@ export abstract class CustomKeyMap<TKey, TValue> implements Map<TKey, TValue> {
   get(key: TKey): TValue | undefined {
     return this.#map.get(this.#keySerializer(key))?.[1]
   }
+  getOrFail(key: TKey): TValue {
+    const value = this.get(key)
+    if (value === undefined) {
+      throw internal.errors.internalError('Key not found')
+    }
+    return value
+  }
   has(key: TKey): boolean {
     return this.#map.has(this.#keySerializer(key))
   }
@@ -62,6 +69,18 @@ export class AccountMap<TValue> extends CustomKeyMap<Account, TValue> {
   }
 
   private static getAddressStrFromAccount = (acc: Account) => {
-    return encodingUtil.uint8ArrayToHex(internal.primitives.BytesCls.fromCompat(acc.bytes).asUint8Array())
+    return asBytesCls(acc.bytes).valueOf()
+  }
+}
+
+export class BytesMap<TValue> extends CustomKeyMap<internal.primitives.StubBytesCompat, TValue> {
+  constructor() {
+    super((bytes) => asBytesCls(bytes).valueOf())
+  }
+}
+
+export class Uint64Map<TValue> extends CustomKeyMap<internal.primitives.StubUint64Compat, TValue> {
+  constructor() {
+    super((uint64) => asUint64Cls(uint64).valueOf())
   }
 }

src/collections/custom-key-map.ts

@@ -61,8 +61,7 @@ class InternalContext {
   }
 
   getApplicationData(id: internal.primitives.StubUint64Compat): ApplicationData {
-    const key = internal.primitives.Uint64Cls.fromCompat(id)
-    const data = this.ledger.applicationDataMap.get(key.asBigInt())
+    const data = this.ledger.applicationDataMap.get(id)
     if (!data) {
       throw internal.errors.internalError('Unknown application, check correct testing context is active')
     }

src/context-helpers/internal-context.ts

@@ -1,4 +1,5 @@
 import { Account, Application, Asset, bytes, internal, uint64 } from '@algorandfoundation/algorand-typescript'
+import { Uint64Map } from '../collections/custom-key-map'
 import { DEFAULT_ACCOUNT_MIN_BALANCE, ZERO_ADDRESS } from '../constants'
 import { lazyContext } from '../context-helpers/internal-context'
 import { Mutable } from '../typescript-helpers'
@@ -17,8 +18,8 @@ export class AssetHolding {
 }
 
 export class AccountData {
-  optedAssets = new Map<bigint, AssetHolding>()
-  optedApplications = new Map<bigint, Application>()
+  optedAssets = new Uint64Map<AssetHolding>()
+  optedApplications = new Uint64Map<Application>()
   account: Mutable<Omit<Account, 'bytes' | 'isOptedIn'>>
 
   constructor() {
@@ -91,7 +92,7 @@ export class AccountCls extends BytesBackedCls implements Account {
 
   isOptedIn(assetOrApp: Asset | Application): boolean {
     if (assetOrApp instanceof AssetCls) {
-      return this.data.optedAssets.has(asUint64Cls(assetOrApp.id).asBigInt())
+      return this.data.optedAssets.has(assetOrApp.id)
     }
     if (assetOrApp instanceof ApplicationCls) {
       return this.data.optedApplications.has(asUint64Cls(assetOrApp.id).asBigInt())

src/impl/account.ts

@@ -22,51 +22,51 @@ export const minBalance = (a: Account | internal.primitives.StubUint64Compat): u
 }
 
 export const AcctParams: internal.opTypes.AcctParamsType = {
-  acctBalance: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctBalance(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.balance, acct.balance !== 0]
   },
-  acctMinBalance: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctMinBalance(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.minBalance, acct.balance !== 0]
   },
-  acctAuthAddr: function (a: Account | internal.primitives.StubUint64Compat): readonly [Account, boolean] {
+  acctAuthAddr(a: Account | internal.primitives.StubUint64Compat): readonly [Account, boolean] {
     const acct = getAccount(a)
     return [acct.authAddress, acct.balance !== 0]
   },
-  acctTotalNumUint: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalNumUint(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalNumUint, acct.balance !== 0]
   },
-  acctTotalNumByteSlice: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalNumByteSlice(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalNumByteSlice, acct.balance !== 0]
   },
-  acctTotalExtraAppPages: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalExtraAppPages(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalExtraAppPages, acct.balance !== 0]
   },
-  acctTotalAppsCreated: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalAppsCreated(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalAppsCreated, acct.balance !== 0]
   },
-  acctTotalAppsOptedIn: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalAppsOptedIn(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalAppsOptedIn, acct.balance !== 0]
   },
-  acctTotalAssetsCreated: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalAssetsCreated(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalAssetsCreated, acct.balance !== 0]
   },
-  acctTotalAssets: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalAssets(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalAssets, acct.balance !== 0]
   },
-  acctTotalBoxes: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalBoxes(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalBoxes, acct.balance !== 0]
   },
-  acctTotalBoxBytes: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+  acctTotalBoxBytes(a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
     const acct = getAccount(a)
     return [acct.totalBoxBytes, acct.balance !== 0]
   },

src/impl/acct-params.ts

@@ -0,0 +1,41 @@
+import { Application, Bytes, bytes, internal, Uint64, uint64 } from '@algorandfoundation/algorand-typescript'
+import { lazyContext } from '../context-helpers/internal-context'
+import { asBytes } from '../util'
+import { getApp } from './app-params'
+
+export const AppGlobal: internal.opTypes.AppGlobalType = {
+  delete(a: internal.primitives.StubBytesCompat): void {
+    lazyContext.ledger.setGlobalState(lazyContext.activeApplication, a, undefined)
+  },
+  getBytes(a: internal.primitives.StubBytesCompat): bytes {
+    return this.getExBytes(0, asBytes(a))[0]
+  },
+  getUint64(a: internal.primitives.StubBytesCompat): uint64 {
+    return this.getExUint64(0, asBytes(a))[0]
+  },
+  getExBytes(a: Application | internal.primitives.StubUint64Compat, b: internal.primitives.StubBytesCompat): readonly [bytes, boolean] {
+    const app = getApp(a)
+    if (app === undefined) {
+      return [Bytes(), false]
+    }
+    const [state, exists] = lazyContext.ledger.getGlobalState(app, b)
+    if (!exists) {
+      return [Bytes(), false]
+    }
+    return [state!.value as bytes, exists]
+  },
+  getExUint64(a: Application | internal.primitives.StubUint64Compat, b: internal.primitives.StubBytesCompat): readonly [uint64, boolean] {
+    const app = getApp(a)
+    if (app === undefined) {
+      return [Uint64(0), false]
+    }
+    const [state, exists] = lazyContext.ledger.getGlobalState(app, b)
+    if (!exists) {
+      return [Uint64(0), false]
+    }
+    return [state!.value as uint64, exists]
+  },
+  put(a: internal.primitives.StubBytesCompat, b: internal.primitives.StubUint64Compat | internal.primitives.StubBytesCompat): void {
+    lazyContext.ledger.setGlobalState(lazyContext.activeApplication, a, b)
+  },
+}