Merge pull request #43 from algorandfoundation/refactor/import

refactor: export more functions under internal namespace for import replacement pattern

Author: boblat

examples/simple-voting/contract.algo.ts

@@ -1,5 +1,15 @@
 import type { Account, bytes, uint64 } from '@algorandfoundation/algorand-typescript'
-import { assert, BaseContract, Bytes, GlobalState, LocalState, op, TransactionType, Uint64 } from '@algorandfoundation/algorand-typescript'
+import {
+  assert,
+  BaseContract,
+  Bytes,
+  GlobalState,
+  gtxn,
+  LocalState,
+  op,
+  TransactionType,
+  Uint64,
+} from '@algorandfoundation/algorand-typescript'
 
 const VOTE_PRICE = Uint64(10_000)
 export default class SimpleVotingContract extends BaseContract {
@@ -34,6 +44,7 @@ export default class SimpleVotingContract extends BaseContract {
 
   private vote(voter: Account): boolean {
     assert(op.Global.groupSize === Uint64(2))
+    assert(gtxn.PaymentTxn(1).amount === VOTE_PRICE)
     assert(op.GTxn.amount(1) === VOTE_PRICE)
     assert(op.GTxn.typeEnum(1) === TransactionType.Payment)
 

package-lock.json

@@ -64,7 +64,7 @@
     "tslib": "^2.6.2"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.10",
+    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.11",
     "@algorandfoundation/puya-ts": "^1.0.0-beta.13",
     "elliptic": "^6.5.7",
     "js-sha256": "^0.11.0",

package.json

@@ -210,3 +210,11 @@ export const GTxn: typeof op.GTxn = {
     return lazyContext.activeGroup.getApplicationTransaction(t).numClearStateProgramPages
   },
 }
+
+export const Transaction = (index: uint64) => lazyContext.txn.activeGroup.getTransaction(index)
+export const PaymentTxn = (index: uint64) => lazyContext.txn.activeGroup.getPaymentTransaction(index)
+export const KeyRegistrationTxn = (index: uint64) => lazyContext.txn.activeGroup.getKeyRegistrationTransaction(index)
+export const AssetConfigTxn = (index: uint64) => lazyContext.txn.activeGroup.getAssetConfigTransaction(index)
+export const AssetTransferTxn = (index: uint64) => lazyContext.txn.activeGroup.getAssetTransferTransaction(index)
+export const AssetFreezeTxn = (index: uint64) => lazyContext.txn.activeGroup.getAssetFreezeTransaction(index)
+export const ApplicationTxn = (index: uint64) => lazyContext.txn.activeGroup.getApplicationTransaction(index)

src/impl/gtxn.ts

@@ -5,8 +5,30 @@ export { Global } from './impl/global'
 export { log } from './impl/log'
 export { assertMatchImpl as assertMatch, matchImpl as match } from './impl/match'
 export { Account, Application, Asset } from './impl/reference'
+export { Box, BoxMap, BoxRef, GlobalState, LocalState } from './impl/state'
 export { TemplateVarImpl as TemplateVar } from './impl/template-var'
 export { Txn } from './impl/txn'
 export { urangeImpl as urange } from './impl/urange'
 export * as arc4 from './internal-arc4'
 export * as op from './internal-op'
+import { ApplicationTxn, AssetConfigTxn, AssetFreezeTxn, AssetTransferTxn, KeyRegistrationTxn, PaymentTxn, Transaction } from './impl/gtxn'
+export const gtxn = {
+  Transaction,
+  PaymentTxn,
+  KeyRegistrationTxn,
+  AssetConfigTxn,
+  AssetTransferTxn,
+  AssetFreezeTxn,
+  ApplicationTxn,
+}
+
+import { applicationCall, assetConfig, assetFreeze, assetTransfer, keyRegistration, payment, submitGroup } from './impl/inner-transactions'
+export const itxn = {
+  submitGroup,
+  payment,
+  keyRegistration,
+  assetConfig,
+  assetTransfer,
+  assetFreeze,
+  applicationCall,
+}

src/internal.ts

@@ -3,7 +3,7 @@ import { internal } from '@algorandfoundation/algorand-typescript'
 import { captureMethodConfig } from './abi-metadata'
 import { DEFAULT_TEMPLATE_VAR_PREFIX } from './constants'
 import type { DecodedLogs, LogDecoding } from './decode-logs'
-import * as ops from './impl'
+import { ApplicationTxn, AssetConfigTxn, AssetFreezeTxn, AssetTransferTxn, KeyRegistrationTxn, PaymentTxn, Transaction } from './impl/gtxn'
 import {
   applicationCall as itxnApplicationCall,
   assetConfig as itxnAssetConfig,
@@ -47,11 +47,6 @@ export class TestExecutionContext implements internal.ExecutionContext {
     return this.txn.exportLogs(appId, ...decoding)
   }
 
-  /* @internal */
-  get op() {
-    return ops
-  }
-
   get contract() {
     return this.#contractContext
   }
@@ -82,13 +77,13 @@ export class TestExecutionContext implements internal.ExecutionContext {
   /* @internal */
   get gtxn() {
     return {
-      Transaction: (index: uint64) => this.txn.activeGroup.getTransaction(index),
-      PaymentTxn: (index: uint64) => this.txn.activeGroup.getPaymentTransaction(index),
-      KeyRegistrationTxn: (index: uint64) => this.txn.activeGroup.getKeyRegistrationTransaction(index),
-      AssetConfigTxn: (index: uint64) => this.txn.activeGroup.getAssetConfigTransaction(index),
-      AssetTransferTxn: (index: uint64) => this.txn.activeGroup.getAssetTransferTransaction(index),
-      AssetFreezeTxn: (index: uint64) => this.txn.activeGroup.getAssetFreezeTransaction(index),
-      ApplicationTxn: (index: uint64) => this.txn.activeGroup.getApplicationTransaction(index),
+      Transaction,
+      PaymentTxn,
+      KeyRegistrationTxn,
+      AssetConfigTxn,
+      AssetTransferTxn,
+      AssetFreezeTxn,
+      ApplicationTxn,
     }
   }