@algorandfoundation/algorand-typescript-testing 1.0.0-beta.3 → 1.0.0-beta.30

package/README.md

@@ -0,0 +1,285 @@
+# 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 behaviors 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.
+
+#### 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: ['**/*.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, 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
+  }
+
+  @arc4.abimethod({ readonly: true })
+  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})`.
+
+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](./docs/testing-guide/index.md)
+- [Examples](./docs/examples.md)
+- [Coverage](./docs/coverage.md)
+- [FQA](./docs/faq.md)
+- [API Reference](./docs/api.md)
+- [Algorand TypeScript](./docs/algots.md)

package/abi-metadata-Dqh8iYjB.js

@@ -0,0 +1,117 @@
+import js_sha512 from 'js-sha512';
+import { d as BaseContract, al as getArc4TypeName$1 } from './crypto-BMTigz9x.js';
+
+class Contract extends BaseContract {
+    static isArc4 = true;
+    approvalProgram() {
+        return true;
+    }
+}
+const Arc4MethodConfigSymbol = Symbol('Arc4MethodConfig');
+function abimethod(config) {
+    return function (target) {
+        target[Arc4MethodConfigSymbol] = {
+            ...config,
+            onCreate: config?.onCreate ?? 'disallow',
+            allowActions: [].concat(config?.allowActions ?? 'NoOp'),
+        };
+        return target;
+    };
+}
+function baremethod(config) {
+    return function (target) {
+        target[Arc4MethodConfigSymbol] = {
+            ...config,
+            onCreate: config?.onCreate ?? 'disallow',
+            allowActions: [].concat(config?.allowActions ?? 'NoOp'),
+        };
+        return target;
+    };
+}
+
+const metadataStore = new WeakMap();
+const attachAbiMetadata = (contract, methodName, metadata) => {
+    if (!metadataStore.has(contract)) {
+        metadataStore.set(contract, {});
+    }
+    const metadatas = metadataStore.get(contract);
+    metadatas[methodName] = metadata;
+};
+const getContractAbiMetadata = (contract) => {
+    // Initialize result object to store merged metadata
+    const result = {};
+    // Get the contract's class
+    let currentClass = contract instanceof Contract ? contract.constructor : contract;
+    // Walk up the prototype chain
+    while (currentClass && currentClass.prototype) {
+        // Find metadata for current class
+        const currentMetadata = metadataStore.get(currentClass);
+        if (currentMetadata) {
+            // Merge metadata with existing result (don't override existing entries)
+            const classMetadata = currentMetadata;
+            for (const [methodName, metadata] of Object.entries(classMetadata)) {
+                if (!(methodName in result)) {
+                    result[methodName] = {
+                        ...metadata,
+                        ...currentClass.prototype?.[methodName]?.[Arc4MethodConfigSymbol],
+                    };
+                }
+            }
+        }
+        // Move up the prototype chain
+        currentClass = Object.getPrototypeOf(currentClass);
+    }
+    return result;
+};
+const getContractMethodAbiMetadata = (contract, methodName) => {
+    const metadatas = getContractAbiMetadata(contract);
+    return metadatas[methodName];
+};
+const getArc4Signature = (metadata) => {
+    if (metadata.methodSignature === undefined) {
+        const argTypes = metadata.argTypes.map((t) => JSON.parse(t)).map(getArc4TypeName);
+        const returnType = getArc4TypeName(JSON.parse(metadata.returnType));
+        metadata.methodSignature = `${metadata.name ?? metadata.methodName}(${argTypes.join(',')})${returnType}`;
+    }
+    return metadata.methodSignature;
+};
+const getArc4Selector = (metadata) => {
+    const hash = js_sha512.sha512_256.array(getArc4Signature(metadata));
+    return new Uint8Array(hash.slice(0, 4));
+};
+const getArc4TypeName = (t) => {
+    const map = {
+        void: 'void',
+        account: 'account',
+        application: 'application',
+        asset: 'asset',
+        boolean: 'bool',
+        biguint: 'uint512',
+        bytes: 'byte[]',
+        string: 'string',
+        uint64: 'uint64',
+        OnCompleteAction: 'uint64',
+        TransactionType: 'uint64',
+        Transaction: 'txn',
+        PaymentTxn: 'pay',
+        KeyRegistrationTxn: 'keyreg',
+        AssetConfigTxn: 'acfg',
+        AssetTransferTxn: 'axfer',
+        AssetFreezeTxn: 'afrz',
+        ApplicationTxn: 'appl',
+        'Tuple(<.*>)?': (t) => `(${Object.values(t.genericArgs)
+            .map(getArc4TypeName)
+            .join(',')})`,
+    };
+    const entry = Object.entries(map).find(([k, _]) => new RegExp(`^${k}$`, 'i').test(t.name))?.[1];
+    if (entry === undefined) {
+        return getArc4TypeName$1(t) ?? t.name;
+    }
+    if (entry instanceof Function) {
+        return entry(t);
+    }
+    return entry;
+};
+
+export { Contract as C, getContractMethodAbiMetadata as a, getContractAbiMetadata as b, abimethod as c, baremethod as d, attachAbiMetadata as e, getArc4Selector as g };
+//# sourceMappingURL=abi-metadata-Dqh8iYjB.js.map

package/abi-metadata-Dqh8iYjB.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abi-metadata-Dqh8iYjB.js","sources":["../src/impl/contract.ts","../src/abi-metadata.ts"],"sourcesContent":["import type { arc4, OnCompleteActionStr } from '@algorandfoundation/algorand-typescript'\nimport type { DeliberateAny } from '../typescript-helpers'\nimport { BaseContract } from './base-contract'\n\nexport class Contract extends BaseContract {\n  static isArc4 = true\n\n  override approvalProgram(): boolean {\n    return true\n  }\n}\n\nexport const Arc4MethodConfigSymbol = Symbol('Arc4MethodConfig')\nexport function abimethod<TContract extends Contract>(config?: arc4.AbiMethodConfig<TContract>) {\n  return function <TArgs extends DeliberateAny[], TReturn>(\n    target: { [Arc4MethodConfigSymbol]: arc4.AbiMethodConfig<TContract> } & ((this: TContract, ...args: TArgs) => TReturn),\n  ): (this: TContract, ...args: TArgs) => TReturn {\n    target[Arc4MethodConfigSymbol] = {\n      ...config,\n      onCreate: config?.onCreate ?? 'disallow',\n      allowActions: ([] as OnCompleteActionStr[]).concat(config?.allowActions ?? 'NoOp'),\n    }\n    return target\n  }\n}\n\nexport function baremethod<TContract extends Contract>(config?: arc4.BareMethodConfig) {\n  return function <TArgs extends DeliberateAny[], TReturn>(\n    target: { [Arc4MethodConfigSymbol]: arc4.AbiMethodConfig<TContract> } & ((this: TContract, ...args: TArgs) => TReturn),\n  ): (this: TContract, ...args: TArgs) => TReturn {\n    target[Arc4MethodConfigSymbol] = {\n      ...config,\n      onCreate: config?.onCreate ?? 'disallow',\n      allowActions: ([] as OnCompleteActionStr[]).concat(config?.allowActions ?? 'NoOp'),\n    }\n    return target\n  }\n}\n","import type { OnCompleteActionStr } from '@algorandfoundation/algorand-typescript'\nimport type { CreateOptions } from '@algorandfoundation/algorand-typescript/arc4'\nimport js_sha512 from 'js-sha512'\nimport type { TypeInfo } from './encoders'\nimport { Arc4MethodConfigSymbol, Contract } from './impl/contract'\nimport { getArc4TypeName as getArc4TypeNameForARC4Encoded } from './impl/encoded-types'\nimport type { DeliberateAny } from './typescript-helpers'\n\nexport interface AbiMetadata {\n  methodName: string\n  name?: string\n  methodSignature: string | undefined\n  argTypes: string[]\n  returnType: string\n  onCreate?: CreateOptions\n  allowActions?: OnCompleteActionStr[]\n}\n\nconst metadataStore: WeakMap<{ new (): Contract }, Record<string, AbiMetadata>> = new WeakMap()\nexport const attachAbiMetadata = (contract: { new (): Contract }, methodName: string, metadata: AbiMetadata): void => {\n  if (!metadataStore.has(contract)) {\n    metadataStore.set(contract, {})\n  }\n  const metadatas: Record<string, AbiMetadata> = metadataStore.get(contract) as Record<string, AbiMetadata>\n  metadatas[methodName] = metadata\n}\n\nexport const getContractAbiMetadata = <T extends Contract>(contract: T | { new (): T }): Record<string, AbiMetadata> => {\n  // Initialize result object to store merged metadata\n  const result: Record<string, AbiMetadata> = {}\n\n  // Get the contract's class\n  let currentClass = contract instanceof Contract ? (contract.constructor as { new (): T }) : contract\n\n  // Walk up the prototype chain\n  while (currentClass && currentClass.prototype) {\n    // Find metadata for current class\n    const currentMetadata = metadataStore.get(currentClass)\n\n    if (currentMetadata) {\n      // Merge metadata with existing result (don't override existing entries)\n      const classMetadata = currentMetadata\n      for (const [methodName, metadata] of Object.entries(classMetadata)) {\n        if (!(methodName in result)) {\n          result[methodName] = {\n            ...metadata,\n            ...(currentClass.prototype as DeliberateAny)?.[methodName]?.[Arc4MethodConfigSymbol],\n          }\n        }\n      }\n    }\n\n    // Move up the prototype chain\n    currentClass = Object.getPrototypeOf(currentClass)\n  }\n\n  return result\n}\n\nexport const getContractMethodAbiMetadata = <T extends Contract>(contract: T, methodName: string): AbiMetadata => {\n  const metadatas = getContractAbiMetadata(contract)\n  return metadatas[methodName]\n}\n\nexport const getArc4Signature = (metadata: AbiMetadata): string => {\n  if (metadata.methodSignature === undefined) {\n    const argTypes = metadata.argTypes.map((t) => JSON.parse(t) as TypeInfo).map(getArc4TypeName)\n    const returnType = getArc4TypeName(JSON.parse(metadata.returnType) as TypeInfo)\n    metadata.methodSignature = `${metadata.name ?? metadata.methodName}(${argTypes.join(',')})${returnType}`\n  }\n  return metadata.methodSignature\n}\n\nexport const getArc4Selector = (metadata: AbiMetadata): Uint8Array => {\n  const hash = js_sha512.sha512_256.array(getArc4Signature(metadata))\n  return new Uint8Array(hash.slice(0, 4))\n}\n\nconst getArc4TypeName = (t: TypeInfo): string => {\n  const map: Record<string, string | ((t: TypeInfo) => string)> = {\n    void: 'void',\n    account: 'account',\n    application: 'application',\n    asset: 'asset',\n    boolean: 'bool',\n    biguint: 'uint512',\n    bytes: 'byte[]',\n    string: 'string',\n    uint64: 'uint64',\n    OnCompleteAction: 'uint64',\n    TransactionType: 'uint64',\n    Transaction: 'txn',\n    PaymentTxn: 'pay',\n    KeyRegistrationTxn: 'keyreg',\n    AssetConfigTxn: 'acfg',\n    AssetTransferTxn: 'axfer',\n    AssetFreezeTxn: 'afrz',\n    ApplicationTxn: 'appl',\n    'Tuple(<.*>)?': (t) =>\n      `(${Object.values(t.genericArgs as Record<string, TypeInfo>)\n        .map(getArc4TypeName)\n        .join(',')})`,\n  }\n  const entry = Object.entries(map).find(([k, _]) => new RegExp(`^${k}$`, 'i').test(t.name))?.[1]\n  if (entry === undefined) {\n    return getArc4TypeNameForARC4Encoded(t) ?? t.name\n  }\n  if (entry instanceof Function) {\n    return entry(t)\n  }\n  return entry\n}\n"],"names":["getArc4TypeNameForARC4Encoded"],"mappings":";;;AAIM,MAAO,QAAS,SAAQ,YAAY,CAAA;AACxC,IAAA,OAAO,MAAM,GAAG,IAAI;IAEX,eAAe,GAAA;AACtB,QAAA,OAAO,IAAI;;;AAIR,MAAM,sBAAsB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC1D,SAAU,SAAS,CAA6B,MAAwC,EAAA;AAC5F,IAAA,OAAO,UACL,MAAsH,EAAA;QAEtH,MAAM,CAAC,sBAAsB,CAAC,GAAG;AAC/B,YAAA,GAAG,MAAM;AACT,YAAA,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,UAAU;YACxC,YAAY,EAAG,EAA4B,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,IAAI,MAAM,CAAC;SACnF;AACD,QAAA,OAAO,MAAM;AACf,KAAC;AACH;AAEM,SAAU,UAAU,CAA6B,MAA8B,EAAA;AACnF,IAAA,OAAO,UACL,MAAsH,EAAA;QAEtH,MAAM,CAAC,sBAAsB,CAAC,GAAG;AAC/B,YAAA,GAAG,MAAM;AACT,YAAA,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,UAAU;YACxC,YAAY,EAAG,EAA4B,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,IAAI,MAAM,CAAC;SACnF;AACD,QAAA,OAAO,MAAM;AACf,KAAC;AACH;;ACnBA,MAAM,aAAa,GAA+D,IAAI,OAAO,EAAE;AAClF,MAAA,iBAAiB,GAAG,CAAC,QAA8B,EAAE,UAAkB,EAAE,QAAqB,KAAU;IACnH,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;AAChC,QAAA,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;;IAEjC,MAAM,SAAS,GAAgC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAgC;AACzG,IAAA,SAAS,CAAC,UAAU,CAAC,GAAG,QAAQ;AAClC;AAEa,MAAA,sBAAsB,GAAG,CAAqB,QAA2B,KAAiC;;IAErH,MAAM,MAAM,GAAgC,EAAE;;AAG9C,IAAA,IAAI,YAAY,GAAG,QAAQ,YAAY,QAAQ,GAAI,QAAQ,CAAC,WAA6B,GAAG,QAAQ;;AAGpG,IAAA,OAAO,YAAY,IAAI,YAAY,CAAC,SAAS,EAAE;;QAE7C,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC;QAEvD,IAAI,eAAe,EAAE;;YAEnB,MAAM,aAAa,GAAG,eAAe;AACrC,YAAA,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;AAClE,gBAAA,IAAI,EAAE,UAAU,IAAI,MAAM,CAAC,EAAE;oBAC3B,MAAM,CAAC,UAAU,CAAC,GAAG;AACnB,wBAAA,GAAG,QAAQ;wBACX,GAAI,YAAY,CAAC,SAA2B,GAAG,UAAU,CAAC,GAAG,sBAAsB,CAAC;qBACrF;;;;;AAMP,QAAA,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC;;AAGpD,IAAA,OAAO,MAAM;AACf;MAEa,4BAA4B,GAAG,CAAqB,QAAW,EAAE,UAAkB,KAAiB;AAC/G,IAAA,MAAM,SAAS,GAAG,sBAAsB,CAAC,QAAQ,CAAC;AAClD,IAAA,OAAO,SAAS,CAAC,UAAU,CAAC;AAC9B;AAEO,MAAM,gBAAgB,GAAG,CAAC,QAAqB,KAAY;AAChE,IAAA,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE;QAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAa,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;AAC7F,QAAA,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAa,CAAC;QAC/E,QAAQ,CAAC,eAAe,GAAG,CAAA,EAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,UAAU,CAAI,CAAA,EAAA,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,CAAA,EAAI,UAAU,CAAA,CAAE;;IAE1G,OAAO,QAAQ,CAAC,eAAe;AACjC,CAAC;AAEY,MAAA,eAAe,GAAG,CAAC,QAAqB,KAAgB;AACnE,IAAA,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AACnE,IAAA,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzC;AAEA,MAAM,eAAe,GAAG,CAAC,CAAW,KAAY;AAC9C,IAAA,MAAM,GAAG,GAAuD;AAC9D,QAAA,IAAI,EAAE,MAAM;AACZ,QAAA,OAAO,EAAE,SAAS;AAClB,QAAA,WAAW,EAAE,aAAa;AAC1B,QAAA,KAAK,EAAE,OAAO;AACd,QAAA,OAAO,EAAE,MAAM;AACf,QAAA,OAAO,EAAE,SAAS;AAClB,QAAA,KAAK,EAAE,QAAQ;AACf,QAAA,MAAM,EAAE,QAAQ;AAChB,QAAA,MAAM,EAAE,QAAQ;AAChB,QAAA,gBAAgB,EAAE,QAAQ;AAC1B,QAAA,eAAe,EAAE,QAAQ;AACzB,QAAA,WAAW,EAAE,KAAK;AAClB,QAAA,UAAU,EAAE,KAAK;AACjB,QAAA,kBAAkB,EAAE,QAAQ;AAC5B,QAAA,cAAc,EAAE,MAAM;AACtB,QAAA,gBAAgB,EAAE,OAAO;AACzB,QAAA,cAAc,EAAE,MAAM;AACtB,QAAA,cAAc,EAAE,MAAM;AACtB,QAAA,cAAc,EAAE,CAAC,CAAC,KAChB,CAAA,CAAA,EAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,WAAuC;aACxD,GAAG,CAAC,eAAe;aACnB,IAAI,CAAC,GAAG,CAAC,CAAG,CAAA,CAAA;KAClB;AACD,IAAA,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,CAAI,CAAA,EAAA,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/F,IAAA,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAOA,iBAA6B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI;;AAEnD,IAAA,IAAI,KAAK,YAAY,QAAQ,EAAE;AAC7B,QAAA,OAAO,KAAK,CAAC,CAAC,CAAC;;AAEjB,IAAA,OAAO,KAAK;AACd,CAAC;;;;"}

package/abi-metadata.d.ts

@@ -1,21 +1,21 @@
-import { BaseContract, Contract } from '@algorandfoundation/algorand-typescript';
-import { AbiMethodConfig, BareMethodConfig, CreateOptions, OnCompleteActionStr } from '@algorandfoundation/algorand-typescript/arc4';
+import type { OnCompleteActionStr } from '@algorandfoundation/algorand-typescript';
+import type { CreateOptions } from '@algorandfoundation/algorand-typescript/arc4';
+import { Contract } from './impl/contract';
 export interface AbiMetadata {
     methodName: string;
+    name?: string;
     methodSignature: string | undefined;
     argTypes: string[];
     returnType: string;
     onCreate?: CreateOptions;
     allowActions?: OnCompleteActionStr[];
 }
-export declare const isContractProxy: unique symbol;
 export declare const attachAbiMetadata: (contract: {
     new (): Contract;
 }, methodName: string, metadata: AbiMetadata) => void;
-export declare const copyAbiMetadatas: <T extends BaseContract>(sourceContract: T, targetContract: T) => 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 getContractAbiMetadata: <T extends BaseContract>(contract: T) => Record<string, AbiMetadata>;
-export declare const getContractMethodAbiMetadata: <T extends BaseContract>(contract: T, methodName: string) => AbiMetadata;
+export declare const getContractAbiMetadata: <T extends Contract>(contract: T | {
+    new (): T;
+}) => Record<string, AbiMetadata>;
+export declare const getContractMethodAbiMetadata: <T extends Contract>(contract: T, methodName: string) => AbiMetadata;
 export declare const getArc4Signature: (metadata: AbiMetadata) => string;
 export declare const getArc4Selector: (metadata: AbiMetadata) => Uint8Array;

package/arc4-DMlP46RF.js

@@ -0,0 +1,40 @@
+import * as arc4$1 from '@algorandfoundation/algorand-typescript/arc4';
+import { a as getContractMethodAbiMetadata, g as getArc4Selector, C as Contract, c as abimethod, d as baremethod } from './abi-metadata-Dqh8iYjB.js';
+import { encodingUtil } from '@algorandfoundation/puya-ts';
+import { am as sha512_256, i as Bytes } from './crypto-BMTigz9x.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);
+}
+
+const methodSelector = (methodSignature, contract) => {
+    if (typeof methodSignature === 'string') {
+        return sha512_256(Bytes(encodingUtil.utf8ToUint8Array(methodSignature))).slice(0, 4);
+    }
+    else {
+        const abiMetadata = getContractMethodAbiMetadata(contract, methodSignature.name);
+        return Bytes(getArc4Selector(abiMetadata));
+    }
+};
+
+var arc4 = /*#__PURE__*/_mergeNamespaces({
+    __proto__: null,
+    Contract: Contract,
+    abimethod: abimethod,
+    baremethod: baremethod,
+    methodSelector: methodSelector
+}, [arc4$1]);
+
+export { arc4 as a, methodSelector as m };
+//# sourceMappingURL=arc4-DMlP46RF.js.map

package/arc4-DMlP46RF.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arc4-DMlP46RF.js","sources":["../src/impl/method-selector.ts"],"sourcesContent":["import type { arc4, bytes } from '@algorandfoundation/algorand-typescript'\nimport { encodingUtil } from '@algorandfoundation/puya-ts'\nimport { getArc4Selector, getContractMethodAbiMetadata } from '../abi-metadata'\nimport type { Contract } from './contract'\nimport { sha512_256 } from './crypto'\nimport { Bytes } from './primitives'\n\nexport const methodSelector = <TContract extends Contract>(\n  methodSignature: Parameters<typeof arc4.methodSelector>[0],\n  contract?: TContract,\n): bytes => {\n  if (typeof methodSignature === 'string') {\n    return sha512_256(Bytes(encodingUtil.utf8ToUint8Array(methodSignature))).slice(0, 4)\n  } else {\n    const abiMetadata = getContractMethodAbiMetadata(contract!, methodSignature.name)\n    return Bytes(getArc4Selector(abiMetadata))\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;MAOa,cAAc,GAAG,CAC5B,eAA0D,EAC1D,QAAoB,KACX;AACT,IAAA,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;AACvC,QAAA,OAAO,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;;SAC/E;QACL,MAAM,WAAW,GAAG,4BAA4B,CAAC,QAAS,EAAE,eAAe,CAAC,IAAI,CAAC;AACjF,QAAA,OAAO,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;;AAE9C;;;;;;;;;;;;"}