arc56-generated-algorandfoundation-algokit-utils-ts

Auto-generated typed Algorand smart-contract clients for algorandfoundation/algokit-utils-ts, built from the ARC-56 specs listed below.

Generated by the Arc56Registry pipeline, using the algorandfoundation/algokit-client-generator-ts ARC-56 client generator. Do not edit these files by hand — they are regenerated automatically whenever the source ARC-56 spec changes.

Install

npm install arc56-generated-algorandfoundation-algokit-utils-ts @algorandfoundation/algokit-utils algosdk

Basic usage

Each contract in this package is re-exported under its own namespace (a hash of its source URL is appended to keep multiple contracts in the same repository from colliding), containing a typed <Name>Client for interacting with an already-deployed instance of that contract, plus a <Name>Factory for deploying new instances.

import { AlgorandClient } from "@algorandfoundation/algokit-utils";
import { BoxMapTest_0f0e793d } from "arc56-generated-algorandfoundation-algokit-utils-ts";

const algorand = AlgorandClient.mainNet();
const client = new BoxMapTest_0f0e793d.BoxMapTestClient({
  algorand,
  appId: 123456789n,
});

// call a contract method, e.g.:
// const result = await client.send.someMethod({ args: [...] });

full vs minimal generator mode

Contracts in this package are generated with the client generator's full mode by default, which emits both the typed Client and a deploy/create Factory class. A small number of contracts' full-mode output has been observed to type-check against non-exported internal shapes of @algorandfoundation/algokit-utils's AlgorandClient that break across algokit-utils versions the generator doesn't itself pin against - for those specific contracts only, this package falls back to minimal mode (Client only, no Factory) instead of failing outright. The contracts table below flags any contract generated this way; every other contract includes a working Factory.

Contracts included in this package

| Namespace | Client class | Source ARC-56 spec | | --- | --- | --- | | BoxMapTest_0f0e793d | BoxMapTestClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/box_map/artifacts/BoxMapTest.arc56.json | | ByteArrays_8be2968f | ByteArraysClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/byte_arrays/artifacts/ByteArrays.arc56.json | | DeployError_7ea9bf5b | DeployErrorClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/deploy_error/artifacts/DeployError.arc56.json | | large_5f465786 | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/extra-pages/large.arc56.json | | small_d0f0a6b1 | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/extra-pages/small.arc56.json | | InnerApp_fd7d3fae | InnerAppClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/inner_error/artifacts/InnerApp.arc56.json | | MiddleApp_0db6fe05 | MiddleAppClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/inner_error/artifacts/MiddleApp.arc56.json | | OuterApp_f78330f9 | OuterAppClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/inner_error/artifacts/OuterApp.arc56.json | | NestedStruct_3139e2aa | NestedStructClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/nested_struct/artifacts/NestedStruct.arc56.json | | BaseARC4Contract_be830094 | BaseArc4ContractClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/state/BaseARC4Contract.arc56.json | | ExampleARC4Contract_7ba2a22e | ExampleArc4ContractClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/state/ExampleARC4Contract.arc56.json | | ImmutabilityControlARC4Contract_ffae1208 | ImmutabilityControlArc4ContractClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/state/ImmutabilityControlARC4Contract.arc56.json | | PermanenceControlARC4Contract_29ea841b | PermanenceControlArc4ContractClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/state/PermanenceControlARC4Contract.arc56.json | | State_44d3161f | StateClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-ts/HEAD/tests/example-contracts/state/State.arc56.json |

Versioning

This package uses 1.0.<increment>.<yyyyMMddHH>-style versioning (expressed as valid semver 1.<increment>.<yyyyMMddHH>): a new version is published whenever any of the contracts above change, or whenever the client generator itself is updated. See Arc56Registry for the full generation pipeline and source ARC-56 registry.