feat: add v11 voter params functions

Author: boblat

src/context-helpers/internal-context.ts

@@ -2,6 +2,7 @@ import { Account, BaseContract, internal } from '@algorandfoundation/algorand-ty
 import { AccountData } from '../impl/account'
 import { ApplicationData } from '../impl/application'
 import { AssetData } from '../impl/asset'
+import { VoterData } from '../impl/voter-params'
 import { TransactionGroup } from '../subcontexts/transaction-context'
 import { TestExecutionContext } from '../test-execution-context'
 
@@ -69,6 +70,14 @@ class InternalContext {
     }
     return data
   }
+
+  getVoterData(account: Account): VoterData {
+    const data = this.ledger.voterDataMap.get(account)
+    if (!data) {
+      throw internal.errors.internalError('Unknown voter, check correct testing context is active')
+    }
+    return data
+  }
 }
 
 export const lazyContext = new InternalContext()

src/impl/index.ts

@@ -14,3 +14,4 @@ export { arg } from './logicSigArg'
 export * from './pure'
 export { gloadBytes, gloadUint64, Scratch } from './scratch'
 export { gaid, Txn } from './txn'
+export { VoterParams } from './voter-params'

src/impl/voter-params.ts

@@ -0,0 +1,29 @@
+import { Account, internal, uint64 } from '@algorandfoundation/algorand-typescript'
+import { lazyContext } from '../context-helpers/internal-context'
+import { getAccount } from './acct-params'
+
+export class VoterData {
+  balance: uint64
+  incentiveEligible: boolean
+
+  constructor() {
+    this.balance = 0
+    this.incentiveEligible = false
+  }
+}
+
+const getVoterData = (a: Account | internal.primitives.StubUint64Compat): VoterData => {
+  const acct = getAccount(a)
+  return lazyContext.getVoterData(acct)
+}
+
+export const VoterParams: internal.opTypes.VoterParamsType = {
+  voterBalance: function (a: Account | internal.primitives.StubUint64Compat): readonly [uint64, boolean] {
+    const data = getVoterData(a)
+    return [data.balance, data.balance !== 0]
+  },
+  voterIncentiveEligible: function (a: Account | internal.primitives.StubUint64Compat): readonly [boolean, boolean] {
+    const data = getVoterData(a)
+    return [data.incentiveEligible, data.balance !== 0]
+  },
+}

src/subcontexts/ledger-context.ts

@@ -7,6 +7,7 @@ import { AssetData } from '../impl/asset'
 import { BlockData } from '../impl/block'
 import { GlobalData } from '../impl/global'
 import { GlobalStateCls } from '../impl/state'
+import { VoterData } from '../impl/voter-params'
 import { asBigInt, asMaybeBytesCls, asMaybeUint64Cls, asUint64, asUint64Cls, iterBigInt } from '../util'
 
 export class LedgerContext {
@@ -16,6 +17,7 @@ export class LedgerContext {
   appIdContractMap = new Uint64Map<BaseContract>()
   accountDataMap = new AccountMap<AccountData>()
   assetDataMap = new Uint64Map<AssetData>()
+  voterDataMap = new AccountMap<VoterData>()
   blocks = new Uint64Map<BlockData>()
   globalData = new GlobalData()
 
@@ -120,6 +122,14 @@ export class LedgerContext {
     })
   }
 
+  patchVoterData(account: Account, data: Partial<VoterData>) {
+    const voterData = this.voterDataMap.get(account) ?? new VoterData()
+    this.voterDataMap.set(account, {
+      ...voterData,
+      ...data,
+    })
+  }
+
   patchBlockData(index: internal.primitives.StubUint64Compat, data: Partial<BlockData>): void {
     const i = asUint64(index)
     const blockData = this.blocks.get(i) ?? new BlockData()

tests/state-op-codes.spec.ts

@@ -287,6 +287,17 @@ describe('State op codes', async () => {
     })
   })
 
+  describe('VoterParams', async () => {
+    it('should return the configured balance and incentive eligibility', async () => {
+      const mockAccount = ctx.any.account()
+      ctx.ledger.patchVoterData(mockAccount, { balance: 100, incentiveEligible: true })
+      const balance = op.VoterParams.voterBalance(mockAccount)
+      const incentiveEligible = op.VoterParams.voterIncentiveEligible(mockAccount)
+      expect(balance).toEqual([100, true])
+      expect(incentiveEligible).toEqual([true, true])
+    })
+  })
+
   describe('Global', async () => {
     it('should return the correct global field value', async () => {
       const creator = ctx.any.account()