@algorandfoundation/algorand-typescript-testing 1.0.0 → 1.0.2-beta.1

package/README.md

@@ -0,0 +1,307 @@
+# Algorand TypeScript Testing
+
+[![docs-repository](https://img.shields.io/badge/url-repository-74dfdc?logo=github&style=flat.svg)](https://github.com/algorandfoundation/algorand-typescript-testing/)
+[![learn-AlgoKit](https://img.shields.io/badge/learn-AlgoKit-74dfdc?logo=algorand&mac=flat.svg)](https://developer.algorand.org/algokit/)
+[![github-stars](https://img.shields.io/github/stars/algorandfoundation/algorand-typescript-testing?color=74dfdc&logo=star&style=flat)](https://github.com/algorandfoundation/algorand-typescript-testing)
+[![visitor-badge](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Falgorandfoundation%2Falgorand-typescript-testing&countColor=%2374dfdc&style=flat)](https://github.com/algorandfoundation/algorand-typescript-testing/)
+
+`algorand-typescript-testing` is a companion package to [Algorand Typescript](https://github.com/algorandfoundation/puya-ts/tree/main/packages/algo-ts) that enables efficient unit testing of Algorand TypeScript smart contracts in an offline environment. This package emulates key AVM behaviours without requiring a network connection, offering fast and reliable testing capabilities with a familiar TypeScript interface.
+
+The `algorand-typescript-testing` package provides:
+
+- A simple interface for fast and reliable unit testing
+- An offline testing environment that simulates core AVM functionality
+- A familiar TypeScript experience, compatible with testing frameworks like [vitest](https://vitest.dev/), and [jest](https://jestjs.io/)
+
+## Quick Start
+
+`algorand-typescript` is a prerequisite for `algorand-typescript-testing`, providing stubs and type annotations for Algorand TypeScript syntax. It enhances code completion and type checking when writing smart contracts. Note that this code isn't directly executable in standard Node.js environment; it's compiled by `puya-ts` into TEAL for Algorand Network deployment.
+
+Traditionally, testing Algorand smart contracts involved deployment on sandboxed networks and interacting with live instances. While robust, this approach can be inefficient and lacks versatility for testing Algorand TypeScript code.
+
+Enter `algorand-typescript-testing`: it leverages TypeScript's rich testing ecosystem for unit testing without network deployment. This enables rapid iteration and granular logic testing.
+
+> **NOTE**: While `algorand-typescript-testing` offers valuable unit testing capabilities, it's not a replacement for comprehensive testing. Use it alongside other test types, particularly those running against the actual Algorand Network, for thorough contract validation.
+
+### Prerequisites
+
+- Python 3.12 or later
+- [Algorand Python](https://github.com/algorandfoundation/puya)
+- Node.js 20.x or later
+- [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts)
+
+### Installation
+
+`algorand-typescript-testing` is distributed via [npm](https://www.npmjs.com/package/@algorandfoundation/algorand-typescript-testing/). Install the package using `npm`:
+
+```bash
+npm i @algorandfoundation/algorand-typescript-testing
+```
+
+### Testing your first contract
+
+Let's write a simple contract and test it using the `algorand-typescript-testing` framework.
+
+#### Simulating AVM
+
+`algorand-typescript-testing` includes a TypeScript transformer (`puyaTsTransformer`) that ensures contracts (with `.algo.ts` extension) and tests (with `.algo.spec.ts` or `.algo.test.ts` extensions) behave consistently between Node.js and AVM environments.
+
+The transformer replicates AVM behaviour, such as integer-only arithmetic where `3 / 2` produces `1`. For code requiring standard Node.js behaviour (e.g., `3 / 2` produces `1.5`), place it in separate `.ts` files and reference them from test files.
+
+The transformer also redirects `@algorandfoundation/algorand-typescript` imports to `@algorandfoundation/algorand-typescript-testing/internal` to provide executable implementations of Algorand TypeScript constructs like `Global`, `Box`, `Uint64`, and `clone`.
+
+If there are tests which do not need to be executed in the AVM context such as end to end tests, simply use `.test.ts` or `.spec.ts` file extensions without `.algo` part and the transformer would skip them.
+
+#### Configuring vitest
+
+If you are using [vitest](https://vitest.dev/) with [@rollup/plugin-typescript](https://www.npmjs.com/package/@rollup/plugin-typescript) plugin, configure `puyaTsTransformer` as a `before` stage transformer of the `typescript` plugin in `vitest.config.mts` file.
+
+```typescript
+import typescript from '@rollup/plugin-typescript'
+import { defineConfig } from 'vitest/config'
+import { puyaTsTransformer } from '@algorandfoundation/algorand-typescript-testing/vitest-transformer'
+
+export default defineConfig({
+  esbuild: {},
+  test: {
+    setupFiles: 'vitest.setup.ts',
+  },
+  plugins: [
+    typescript({
+      transformers: {
+        before: [puyaTsTransformer],
+      },
+    }),
+  ],
+})
+```
+
+`algorand-typescript-testing` package also exposes additional equality testers which enables the smart contract developers to write terser test by avoiding type casting in assertions. It can setup in `beforeAll` hook point in the setup file, `vitest.setup.ts`.
+
+```typescript
+import { beforeAll, expect } from 'vitest'
+import { addEqualityTesters } from '@algorandfoundation/algorand-typescript-testing'
+
+beforeAll(() => {
+  addEqualityTesters({ expect })
+})
+```
+
+#### Configuring jest
+
+If you are using [jest](https://jestjs.io/) with [ts-jest](https://www.npmjs.com/package/ts-jest), [@jest/globals](https://www.npmjs.com/package/@jest/globals) and [ts-node](https://www.npmjs.com/package/ts-node) plugins, configure `puyaTsTransformer` as a `before` stage transformer of the `typescript` plugin in `jest.config.ts` file.
+
+```typescript
+import { createDefaultEsmPreset, type JestConfigWithTsJest } from 'ts-jest'
+
+const presetConfig = createDefaultEsmPreset({})
+const jestConfig: JestConfigWithTsJest = {
+  ...presetConfig,
+  testMatch: ['**/*.algo.test.ts'],
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+        astTransformers: {
+          before: ['node_modules/@algorandfoundation/algorand-typescript-testing/test-transformer/jest-transformer.mjs'],
+        },
+      },
+    ],
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+}
+export default jestConfig
+```
+
+`algorand-typescript-testing` package also exposes additional equality testers which enables the smart contract developers to write terser test by avoiding type casting in assertions. It can setup in `beforeAll` hook point in the setup file, `jest.setup.ts`.
+
+```typescript
+import { beforeAll, expect } from '@jest/globals'
+import { addEqualityTesters } from '@algorandfoundation/algorand-typescript-testing'
+
+beforeAll(() => {
+  addEqualityTesters({ expect })
+})
+```
+
+You'll also need to run `jest` with the `--experimental-vm-modules` and `--experimental-require-module` flags in the `package.json`. This requires node 20.17 or greater.
+
+```json
+{
+  "name": "puya-ts-demo",
+  "scripts": {
+    "test:jest": "tsc && node --experimental-vm-modules --experimental-require-module node_modules/jest/bin/jest"
+  },
+  "engines": {
+    "node": ">=20.17"
+  }
+}
+```
+
+There is also a patch file `ts-jest+29.2.5.patch` that needs to be applied to `ts-jest` package to for the `puyaTsTransformer` to work with the test files.
+
+1. Place the file in `<rootDir>\patches` folder.
+1. Install [patch-package](https://www.npmjs.com/package/patch-package) package as a dev dependency.
+1. Add `"postinstall": "patch-package",` script in `package.json` file.
+   The patch will then be applied with every `npm install` call.
+
+```patch
+diff --git a/node_modules/ts-jest/dist/legacy/compiler/ts-compiler.js b/node_modules/ts-jest/dist/legacy/compiler/ts-compiler.js
+index 5198f8f..addb47c 100644
+--- a/node_modules/ts-jest/dist/legacy/compiler/ts-compiler.js
++++ b/node_modules/ts-jest/dist/legacy/compiler/ts-compiler.js
+@@ -234,7 +234,7 @@ var TsCompiler = /** @class */ (function () {
+         var _a;
+         // Initialize memory cache for typescript compiler
+         this._parsedTsConfig.fileNames
+-            .filter(function (fileName) { return constants_1.TS_TSX_REGEX.test(fileName) && !_this.configSet.isTestFile(fileName); })
++            .filter(function (fileName) { return constants_1.TS_TSX_REGEX.test(fileName); })
+             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+             .forEach(function (fileName) { return _this._fileVersionCache.set(fileName, 0); });
+         /* istanbul ignore next */
+
+```
+
+After the setup, the examples provided using `vitest` can be converted to work with `jest` by simply swapping the `import {...} from 'vitest'` with `import {...} from '@jest/globals'`.
+
+#### Contract Definition
+
+```typescript
+import {
+  arc4,
+  assert,
+  Bytes,
+  GlobalState,
+  gtxn,
+  LocalState,
+  op,
+  readonly,
+  Txn,
+  uint64,
+  Uint64,
+} from '@algorandfoundation/algorand-typescript'
+
+export default class VotingContract extends arc4.Contract {
+  topic = GlobalState({ initialValue: 'default_topic', key: Bytes('topic') })
+  votes = GlobalState({ initialValue: Uint64(0), key: Bytes('votes') })
+  voted = LocalState<uint64>({ key: Bytes('voted') })
+
+  @arc4.abimethod()
+  public setTopic(topic: string): void {
+    this.topic.value = topic
+  }
+  @arc4.abimethod()
+  public vote(pay: gtxn.PaymentTxn): boolean {
+    assert(op.Global.groupSize === 2, 'Expected 2 transactions')
+    assert(pay.amount === 10_000, 'Incorrect payment amount')
+    assert(pay.sender === Txn.sender, 'Payment sender must match transaction sender')
+
+    if (this.voted(Txn.sender).hasValue) {
+      return false // Already voted
+    }
+
+    this.votes.value = this.votes.value + 1
+    this.voted(Txn.sender).value = 1
+    return true
+  }
+
+  @readonly
+  public getVotes(): uint64 {
+    return this.votes.value
+  }
+
+  public clearStateProgram(): boolean {
+    return true
+  }
+}
+```
+
+#### Test Definition
+
+```typescript
+import { Uint64 } from '@algorandfoundation/algorand-typescript'
+import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
+import { afterEach, describe, expect, test } from 'vitest'
+import VotingContract from './contract.algo'
+
+describe('Voting contract', () => {
+  const ctx = new TestExecutionContext()
+  afterEach(() => {
+    ctx.reset()
+  })
+
+  test('vote function', () => {
+    // Initialize the contract within the testing context
+    const contract = ctx.contract.create(VotingContract)
+
+    const voter = ctx.defaultSender
+    const payment = ctx.any.txn.payment({
+      sender: voter,
+      amount: 10_000,
+    })
+
+    const result = contract.vote(payment)
+    expect(result).toEqual(true)
+    expect(contract.votes.value).toEqual(1)
+    expect(contract.voted(voter).value).toEqual(1)
+  })
+
+  test('setTopic function', () => {
+    // Initialize the contract within the testing context
+    const contract = ctx.contract.create(VotingContract)
+
+    const newTopic = ctx.any.string(10)
+    contract.setTopic(newTopic)
+    expect(contract.topic.value).toEqual(newTopic)
+  })
+
+  test('getVotes function', () => {
+    // Initialize the contract within the testing context
+    const contract = ctx.contract.create(VotingContract)
+
+    contract.votes.value = 5
+    const votes = contract.getVotes()
+    expect(votes).toEqual(5)
+  })
+})
+```
+
+This example demonstrates key aspects of testing with `algorand-typescript-testing` for ARC4-based contracts:
+
+1. ARC4 Contract Features:
+
+   - Use of `arc4.Contract` as the base class for the contract.
+   - ABI methods defined using the `@arc4.abimethod` decorator.
+   - Readonly method annotation with `@arc4.abimethod({readonly: true})` or `@readonly`.
+
+2. Testing ARC4 Contracts:
+
+   - Creation of an `arc4.Contract` instance within the test context.
+   - Use of `ctx.any` for generating random test data.
+   - Direct invocation of ABI methods on the contract instance.
+
+3. Transaction Handling:
+
+   - Use of `ctx.any.txn` to create test transactions.
+   - Passing transaction objects as parameters to contract methods.
+
+4. State Verification:
+   - Checking global and local state changes after method execution.
+   - Verifying return values from ABI methods.
+
+> **NOTE**: Thorough testing is crucial in smart contract development due to their immutable nature post-deployment. Comprehensive unit and integration tests ensure contract validity and reliability. Optimizing for efficiency can significantly improve user experience by reducing transaction fees and simplifying interactions. Investing in robust testing and optimization practices is crucial and offers many benefits in the long run.
+
+### Next steps
+
+To dig deeper into the capabilities of `algorand-typescript-testing`, continue with the following sections.
+
+#### Contents
+
+- [Testing Guide](https://algorandfoundation.github.io/algorand-typescript-testing/documents/Algorand_TypeScript_Testing_Guide.html)
+- [Examples](https://algorandfoundation.github.io/algorand-typescript-testing/documents/Examples.html)
+- [Coverage](https://algorandfoundation.github.io/algorand-typescript-testing/documents/Coverage.html)
+- [FAQ](https://algorandfoundation.github.io/algorand-typescript-testing/documents/FAQ.html)
+- [API Reference](https://algorandfoundation.github.io/algorand-typescript-testing/documents/API_Reference.html)
+- [Algorand TypeScript](https://algorandfoundation.github.io/algorand-typescript-testing/documents/Algorand_TypeScript.html)

package/abi-metadata.d.ts

@@ -1,16 +1,4 @@
-import { BaseContract, Contract } from '@algorandfoundation/algorand-typescript';
-import { AbiMethodConfig, BareMethodConfig, CreateOptions, OnCompleteActionStr } from '@algorandfoundation/algorand-typescript/arc4';
-export interface AbiMetadata {
-    methodName: string;
-    methodSelector: string;
-    argTypes: string[];
-    returnType: string;
-    onCreate?: CreateOptions;
-    allowActions?: OnCompleteActionStr[];
-}
-export declare const attachAbiMetadata: (contract: {
+import { Contract } from './impl/contract';
+export declare const getContractByName: (contractFullname: string) => {
     new (): Contract;
-}, methodName: string, metadata: AbiMetadata) => void;
-export declare const captureMethodConfig: <T extends Contract>(contract: T, methodName: string, config?: AbiMethodConfig<T> | BareMethodConfig) => void;
-export declare const hasAbiMetadata: <T extends Contract>(contract: T) => boolean;
-export declare const getAbiMetadata: <T extends BaseContract>(contract: T, methodName: string) => AbiMetadata;
+} | undefined;

package/application-spy.d.ts

@@ -0,0 +1,32 @@
+import type { bytes, Contract } from '@algorandfoundation/algorand-typescript';
+import { OnCompleteAction } from '@algorandfoundation/algorand-typescript';
+import type { ApplicationCallInnerTxnContext } from './impl/inner-transactions';
+import type { AnyFunction, ConstructorFor } from './typescript-helpers';
+export type AppSpyCb = (itxnContext: ApplicationCallInnerTxnContext) => void;
+export declare class ApplicationSpy<TContract extends Contract = Contract> {
+    #private;
+    /**
+     * The `on` property is a proxy that allows you to register callbacks for specific method signatures.
+     * It dynamically creates methods based on the contract's methods.
+     */
+    readonly on: TypedApplicationSpyCallBacks<TContract>;
+    constructor(contract?: TContract | ConstructorFor<TContract>);
+    /**
+     * Registers a callback for a bare call (no arguments).
+     * @param callback - The callback to be executed when a bare call is detected.
+     */
+    onBareCall(callback: AppSpyCb): void;
+    onBareCall(ocas: OnCompleteAction[], callback: AppSpyCb): void;
+    /**
+     * Registers a callback for a specific method signature.
+     * @param methodSignature
+     * @param callback
+     */
+    onAbiCall(methodSignature: bytes, callback: AppSpyCb): void;
+    onAbiCall(methodSignature: bytes, ocas: OnCompleteAction[], callback: AppSpyCb): void;
+    private _tryGetMethod;
+    private createOnProxy;
+}
+export type TypedApplicationSpyCallBacks<TContract> = {
+    [key in keyof TContract as key extends 'approvalProgram' | 'clearStateProgram' ? never : TContract[key] extends AnyFunction ? key extends string ? key : never : never]: (callback: AppSpyCb) => void;
+};

package/arc4-DZBwKOPQ.js

@@ -0,0 +1,143 @@
+import * as arc4$1 from '@algorandfoundation/algorand-typescript/arc4';
+import { OnCompleteAction } from '@algorandfoundation/algorand-typescript';
+import { d as getContractByName, g as getContractMethodAbiMetadata, C as Contract, b as abimethod, c as baremethod, r as readonly } from './runtime-helpers-BfpGXQyk.js';
+import { v as lazyContext, a0 as sizeOf } from './utils-fy0_Fvxl.js';
+import { I as InternalError } from './typescript-helpers-sobuICoc.js';
+import { A as ApplicationCallInnerTxnContext, m as methodSelector } from './inner-transactions-Bc7BmlmL.js';
+import { A as Address, B as Bool, c as Byte, d as DynamicArray, D as DynamicBytes, F as FixedArray, R as ReferenceArray, e as StaticArray, f as StaticBytes, S as Str, h as Struct, T as Tuple, i as UFixed, U as Uint, j as convertBytes, k as decodeArc4, l as encodeArc4 } from './asset-params-BwXtTjOo.js';
+
+function _mergeNamespaces(n, m) {
+    m.forEach(function (e) {
+        e && typeof e !== 'string' && !Array.isArray(e) && Object.keys(e).forEach(function (k) {
+            if (k !== 'default' && !(k in n)) {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    });
+    return Object.freeze(n);
+}
+
+/** @internal */
+function compileArc4(contract, options) {
+    let app;
+    const compiledAppEntry = lazyContext.value.getCompiledAppEntry(contract);
+    if (compiledAppEntry !== undefined) {
+        app = lazyContext.ledger.applicationDataMap.get(compiledAppEntry.value);
+    }
+    if (options?.templateVars) {
+        Object.entries(options.templateVars).forEach(([key, value]) => {
+            lazyContext.value.setTemplateVar(key, value, options.templateVarsPrefix);
+        });
+    }
+    return {
+        call: new Proxy({}, {
+            get: (_target, prop) => {
+                return (methodArgs) => {
+                    const selector = methodSelector(prop, contract);
+                    const abiMetadata = getContractMethodAbiMetadata(contract, prop);
+                    const onCompleteActions = abiMetadata?.allowActions?.map((action) => OnCompleteAction[action]);
+                    const itxnContext = ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields({
+                        ...getCommonApplicationCallFields(app, options),
+                        onCompletion: onCompleteActions?.[0],
+                        ...methodArgs,
+                    }, selector, abiMetadata?.resourceEncoding);
+                    invokeAbiCall(itxnContext);
+                    return {
+                        itxn: itxnContext,
+                        returnValue: itxnContext.loggedReturnValue,
+                    };
+                };
+            },
+        }),
+        bareCreate: (methodArgs) => {
+            const itxnContext = ApplicationCallInnerTxnContext.createFromBareCreateApplicationCallFields({
+                ...getCommonApplicationCallFields(app, options),
+                ...methodArgs,
+            });
+            invokeAbiCall(itxnContext);
+            return itxnContext;
+        },
+        approvalProgram: app?.application.approvalProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],
+        clearStateProgram: app?.application.clearStateProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],
+        extraProgramPages: options?.extraProgramPages ?? app?.application.extraProgramPages ?? lazyContext.any.uint64(),
+        globalUints: options?.globalUints ?? app?.application.globalNumUint ?? lazyContext.any.uint64(),
+        globalBytes: options?.globalBytes ?? app?.application.globalNumBytes ?? lazyContext.any.uint64(),
+        localUints: options?.localUints ?? app?.application.localNumUint ?? lazyContext.any.uint64(),
+        localBytes: options?.localBytes ?? app?.application.localNumBytes ?? lazyContext.any.uint64(),
+    };
+}
+/** @internal */
+const invokeAbiCall = (itxnContext) => {
+    lazyContext.value.notifyApplicationSpies(itxnContext);
+    lazyContext.txn.activeGroup.addInnerTransactionGroup(...(itxnContext.itxns ?? []), itxnContext);
+};
+const getCommonApplicationCallFields = (app, options) => ({
+    approvalProgram: app?.application.approvalProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],
+    clearStateProgram: app?.application.clearStateProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],
+    extraProgramPages: options?.extraProgramPages ?? app?.application.extraProgramPages ?? lazyContext.any.uint64(),
+    globalNumUint: options?.globalUints ?? app?.application.globalNumUint ?? lazyContext.any.uint64(),
+    globalNumBytes: options?.globalBytes ?? app?.application.globalNumBytes ?? lazyContext.any.uint64(),
+    localNumUint: options?.localUints ?? app?.application.localNumUint ?? lazyContext.any.uint64(),
+    localNumBytes: options?.localBytes ?? app?.application.localNumBytes ?? lazyContext.any.uint64(),
+});
+/** @internal */
+function getApplicationCallInnerTxnContext(method, methodArgs, contract) {
+    const abiMetadata = contract ? getContractMethodAbiMetadata(contract, method.name) : undefined;
+    const selector = methodSelector(method, contract);
+    return ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields({
+        ...methodArgs,
+        onCompletion: methodArgs.onCompletion ?? abiMetadata?.allowActions?.map((action) => OnCompleteAction[action])[0],
+    }, selector, abiMetadata?.resourceEncoding);
+}
+/** @internal */
+function abiCall(contractFullName, method, methodArgs) {
+    const contract = getContractByName(contractFullName);
+    if (contract === undefined || typeof contract !== 'function')
+        throw new InternalError(`Unknown contract: ${contractFullName}`);
+    if (!Object.hasOwn(contract.prototype, method))
+        throw new InternalError(`Unknown method: ${method} in contract: ${contractFullName}`);
+    const itxnContext = getApplicationCallInnerTxnContext(contract.prototype[method], methodArgs, contract);
+    invokeAbiCall(itxnContext);
+    return {
+        itxn: itxnContext,
+        returnValue: itxnContext.loggedReturnValue,
+    };
+}
+
+/** @internal */
+
+var arc4 = /*#__PURE__*/_mergeNamespaces({
+    __proto__: null,
+    Address: Address,
+    Bool: Bool,
+    Byte: Byte,
+    Contract: Contract,
+    DynamicArray: DynamicArray,
+    DynamicBytes: DynamicBytes,
+    FixedArray: FixedArray,
+    ReferenceArray: ReferenceArray,
+    StaticArray: StaticArray,
+    StaticBytes: StaticBytes,
+    Str: Str,
+    Struct: Struct,
+    Tuple: Tuple,
+    UFixed: UFixed,
+    Uint: Uint,
+    abiCall: abiCall,
+    abimethod: abimethod,
+    baremethod: baremethod,
+    compileArc4: compileArc4,
+    convertBytes: convertBytes,
+    decodeArc4: decodeArc4,
+    encodeArc4: encodeArc4,
+    methodSelector: methodSelector,
+    readonly: readonly,
+    sizeOf: sizeOf
+}, [arc4$1]);
+
+export { arc4 as a, abiCall as b, compileArc4 as c, getApplicationCallInnerTxnContext as g };
+//# sourceMappingURL=arc4-DZBwKOPQ.js.map

package/arc4-DZBwKOPQ.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arc4-DZBwKOPQ.js","sources":["../src/impl/c2c.ts","../src/internal/arc4.ts"],"sourcesContent":["import { type CompileContractOptions, type Contract, OnCompleteAction } from '@algorandfoundation/algorand-typescript'\nimport type {\n  BareCreateApplicationCallFields,\n  ContractProxy,\n  TypedApplicationCallFields,\n} from '@algorandfoundation/algorand-typescript/arc4'\nimport { getContractByName, getContractMethodAbiMetadata } from '../abi-metadata'\nimport { lazyContext } from '../context-helpers/internal-context'\nimport { InternalError } from '../errors'\nimport type { ConstructorFor, DeliberateAny, InstanceMethod } from '../typescript-helpers'\nimport type { ApplicationCallInnerTxn } from './inner-transactions'\nimport { ApplicationCallInnerTxnContext } from './inner-transactions'\nimport { methodSelector } from './method-selector'\nimport type { ApplicationData } from './reference'\n\n/** @internal */\nexport function compileArc4<TContract extends Contract>(\n  contract: ConstructorFor<TContract>,\n  options?: CompileContractOptions,\n): ContractProxy<TContract> {\n  let app: ApplicationData | undefined\n  const compiledAppEntry = lazyContext.value.getCompiledAppEntry(contract)\n  if (compiledAppEntry !== undefined) {\n    app = lazyContext.ledger.applicationDataMap.get(compiledAppEntry.value)\n  }\n\n  if (options?.templateVars) {\n    Object.entries(options.templateVars).forEach(([key, value]) => {\n      lazyContext.value.setTemplateVar(key, value, options.templateVarsPrefix)\n    })\n  }\n\n  return {\n    call: new Proxy({} as unknown as TContract, {\n      get: (_target, prop) => {\n        return (methodArgs: TypedApplicationCallFields<DeliberateAny[]>) => {\n          const selector = methodSelector(prop as string, contract)\n          const abiMetadata = getContractMethodAbiMetadata(contract, prop as string)\n          const onCompleteActions = abiMetadata?.allowActions?.map((action) => OnCompleteAction[action])\n          const itxnContext = ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields(\n            {\n              ...getCommonApplicationCallFields(app, options),\n              onCompletion: onCompleteActions?.[0],\n              ...methodArgs,\n            },\n            selector,\n            abiMetadata?.resourceEncoding,\n          )\n          invokeAbiCall(itxnContext)\n          return {\n            itxn: itxnContext,\n            returnValue: itxnContext.loggedReturnValue,\n          }\n        }\n      },\n    }),\n\n    bareCreate: (methodArgs?: BareCreateApplicationCallFields) => {\n      const itxnContext = ApplicationCallInnerTxnContext.createFromBareCreateApplicationCallFields({\n        ...getCommonApplicationCallFields(app, options),\n        ...methodArgs,\n      })\n      invokeAbiCall(itxnContext)\n      return itxnContext\n    },\n    approvalProgram: app?.application.approvalProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],\n    clearStateProgram: app?.application.clearStateProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],\n    extraProgramPages: options?.extraProgramPages ?? app?.application.extraProgramPages ?? lazyContext.any.uint64(),\n    globalUints: options?.globalUints ?? app?.application.globalNumUint ?? lazyContext.any.uint64(),\n    globalBytes: options?.globalBytes ?? app?.application.globalNumBytes ?? lazyContext.any.uint64(),\n    localUints: options?.localUints ?? app?.application.localNumUint ?? lazyContext.any.uint64(),\n    localBytes: options?.localBytes ?? app?.application.localNumBytes ?? lazyContext.any.uint64(),\n  } as unknown as ContractProxy<TContract>\n}\n\n/** @internal */\nexport const invokeAbiCall = (itxnContext: ApplicationCallInnerTxnContext) => {\n  lazyContext.value.notifyApplicationSpies(itxnContext)\n  lazyContext.txn.activeGroup.addInnerTransactionGroup(...(itxnContext.itxns ?? []), itxnContext)\n}\nconst getCommonApplicationCallFields = (app: ApplicationData | undefined, options: CompileContractOptions | undefined) => ({\n  approvalProgram: app?.application.approvalProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],\n  clearStateProgram: app?.application.clearStateProgram ?? [lazyContext.any.bytes(10), lazyContext.any.bytes(10)],\n  extraProgramPages: options?.extraProgramPages ?? app?.application.extraProgramPages ?? lazyContext.any.uint64(),\n  globalNumUint: options?.globalUints ?? app?.application.globalNumUint ?? lazyContext.any.uint64(),\n  globalNumBytes: options?.globalBytes ?? app?.application.globalNumBytes ?? lazyContext.any.uint64(),\n  localNumUint: options?.localUints ?? app?.application.localNumUint ?? lazyContext.any.uint64(),\n  localNumBytes: options?.localBytes ?? app?.application.localNumBytes ?? lazyContext.any.uint64(),\n})\n\n/** @internal */\nexport function getApplicationCallInnerTxnContext<TArgs extends DeliberateAny[], TReturn = void>(\n  method: InstanceMethod<Contract, TArgs, TReturn>,\n  methodArgs: TypedApplicationCallFields<TArgs>,\n  contract?: Contract | { new (): Contract },\n) {\n  const abiMetadata = contract ? getContractMethodAbiMetadata(contract, method.name) : undefined\n  const selector = methodSelector(method, contract)\n  return ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields<TReturn>(\n    {\n      ...methodArgs,\n      onCompletion: methodArgs.onCompletion ?? abiMetadata?.allowActions?.map((action) => OnCompleteAction[action])[0],\n    },\n    selector,\n    abiMetadata?.resourceEncoding,\n  )\n}\n/** @internal */\nexport function abiCall<TArgs extends DeliberateAny[], TReturn>(\n  contractFullName: string,\n  method: string,\n  methodArgs: TypedApplicationCallFields<TArgs>,\n): { itxn: ApplicationCallInnerTxn; returnValue: TReturn | undefined } {\n  const contract = getContractByName(contractFullName)\n  if (contract === undefined || typeof contract !== 'function') throw new InternalError(`Unknown contract: ${contractFullName}`)\n  if (!Object.hasOwn(contract.prototype, method)) throw new InternalError(`Unknown method: ${method} in contract: ${contractFullName}`)\n\n  const itxnContext = getApplicationCallInnerTxnContext<TArgs, TReturn>(contract.prototype[method], methodArgs, contract)\n\n  invokeAbiCall(itxnContext)\n\n  return {\n    itxn: itxnContext,\n    returnValue: itxnContext.loggedReturnValue,\n  }\n}\n","/** @internal */\nexport * from '@algorandfoundation/algorand-typescript/arc4'\n/** @internal */\nexport { abiCall, compileArc4 } from '../impl/c2c'\n/** @internal */\nexport { abimethod, baremethod, Contract, readonly } from '../impl/contract'\n/** @internal */\nexport {\n  Address,\n  Bool,\n  Byte,\n  convertBytes,\n  decodeArc4,\n  DynamicArray,\n  DynamicBytes,\n  encodeArc4,\n  FixedArray,\n  ReferenceArray,\n  sizeOf,\n  StaticArray,\n  StaticBytes,\n  Str,\n  Struct,\n  Tuple,\n  UFixed,\n  Uint,\n} from '../impl/encoded-types'\n/** @internal */\nexport { methodSelector } from '../impl/method-selector'\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAeA;AACM,SAAU,WAAW,CACzB,QAAmC,EACnC,OAAgC,EAAA;AAEhC,IAAA,IAAI,GAAgC;IACpC,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC;AACxE,IAAA,IAAI,gBAAgB,KAAK,SAAS,EAAE;AAClC,QAAA,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC;IACzE;AAEA,IAAA,IAAI,OAAO,EAAE,YAAY,EAAE;AACzB,QAAA,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;AAC5D,YAAA,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,kBAAkB,CAAC;AAC1E,QAAA,CAAC,CAAC;IACJ;IAEA,OAAO;AACL,QAAA,IAAI,EAAE,IAAI,KAAK,CAAC,EAA0B,EAAE;AAC1C,YAAA,GAAG,EAAE,CAAC,OAAO,EAAE,IAAI,KAAI;gBACrB,OAAO,CAAC,UAAuD,KAAI;oBACjE,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAc,EAAE,QAAQ,CAAC;oBACzD,MAAM,WAAW,GAAG,4BAA4B,CAAC,QAAQ,EAAE,IAAc,CAAC;AAC1E,oBAAA,MAAM,iBAAiB,GAAG,WAAW,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC9F,oBAAA,MAAM,WAAW,GAAG,8BAA8B,CAAC,oCAAoC,CACrF;AACE,wBAAA,GAAG,8BAA8B,CAAC,GAAG,EAAE,OAAO,CAAC;AAC/C,wBAAA,YAAY,EAAE,iBAAiB,GAAG,CAAC,CAAC;AACpC,wBAAA,GAAG,UAAU;AACd,qBAAA,EACD,QAAQ,EACR,WAAW,EAAE,gBAAgB,CAC9B;oBACD,aAAa,CAAC,WAAW,CAAC;oBAC1B,OAAO;AACL,wBAAA,IAAI,EAAE,WAAW;wBACjB,WAAW,EAAE,WAAW,CAAC,iBAAiB;qBAC3C;AACH,gBAAA,CAAC;YACH,CAAC;SACF,CAAC;AAEF,QAAA,UAAU,EAAE,CAAC,UAA4C,KAAI;AAC3D,YAAA,MAAM,WAAW,GAAG,8BAA8B,CAAC,yCAAyC,CAAC;AAC3F,gBAAA,GAAG,8BAA8B,CAAC,GAAG,EAAE,OAAO,CAAC;AAC/C,gBAAA,GAAG,UAAU;AACd,aAAA,CAAC;YACF,aAAa,CAAC,WAAW,CAAC;AAC1B,YAAA,OAAO,WAAW;QACpB,CAAC;QACD,eAAe,EAAE,GAAG,EAAE,WAAW,CAAC,eAAe,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3G,iBAAiB,EAAE,GAAG,EAAE,WAAW,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/G,QAAA,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,IAAI,GAAG,EAAE,WAAW,CAAC,iBAAiB,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAC/G,QAAA,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,EAAE,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAC/F,QAAA,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,EAAE,WAAW,CAAC,cAAc,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAChG,QAAA,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,WAAW,CAAC,YAAY,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAC5F,QAAA,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;KACvD;AAC1C;AAEA;AACO,MAAM,aAAa,GAAG,CAAC,WAA2C,KAAI;AAC3E,IAAA,WAAW,CAAC,KAAK,CAAC,sBAAsB,CAAC,WAAW,CAAC;AACrD,IAAA,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,wBAAwB,CAAC,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,WAAW,CAAC;AACjG,CAAC;AACD,MAAM,8BAA8B,GAAG,CAAC,GAAgC,EAAE,OAA2C,MAAM;IACzH,eAAe,EAAE,GAAG,EAAE,WAAW,CAAC,eAAe,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3G,iBAAiB,EAAE,GAAG,EAAE,WAAW,CAAC,iBAAiB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/G,IAAA,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,IAAI,GAAG,EAAE,WAAW,CAAC,iBAAiB,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAC/G,IAAA,aAAa,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,EAAE,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AACjG,IAAA,cAAc,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,EAAE,WAAW,CAAC,cAAc,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AACnG,IAAA,YAAY,EAAE,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,WAAW,CAAC,YAAY,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AAC9F,IAAA,aAAa,EAAE,OAAO,EAAE,UAAU,IAAI,GAAG,EAAE,WAAW,CAAC,aAAa,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE;AACjG,CAAA,CAAC;AAEF;SACgB,iCAAiC,CAC/C,MAAgD,EAChD,UAA6C,EAC7C,QAA0C,EAAA;AAE1C,IAAA,MAAM,WAAW,GAAG,QAAQ,GAAG,4BAA4B,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS;IAC9F,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;IACjD,OAAO,8BAA8B,CAAC,oCAAoC,CACxE;AACE,QAAA,GAAG,UAAU;QACb,YAAY,EAAE,UAAU,CAAC,YAAY,IAAI,WAAW,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AACjH,KAAA,EACD,QAAQ,EACR,WAAW,EAAE,gBAAgB,CAC9B;AACH;AACA;SACgB,OAAO,CACrB,gBAAwB,EACxB,MAAc,EACd,UAA6C,EAAA;AAE7C,IAAA,MAAM,QAAQ,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;AACpD,IAAA,IAAI,QAAQ,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,UAAU;AAAE,QAAA,MAAM,IAAI,aAAa,CAAC,qBAAqB,gBAAgB,CAAA,CAAE,CAAC;IAC9H,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,CAAA,gBAAA,EAAmB,MAAM,CAAA,cAAA,EAAiB,gBAAgB,CAAA,CAAE,CAAC;AAErI,IAAA,MAAM,WAAW,GAAG,iCAAiC,CAAiB,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC;IAEvH,aAAa,CAAC,WAAW,CAAC;IAE1B,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,WAAW,CAAC,iBAAiB;KAC3C;AACH;;AC7HA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}