arc56-generated-algorandfoundation-algokit-utils-py

Auto-generated typed Algorand smart-contract clients for algorandfoundation/algokit-utils-py, 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-py @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 { amm_03f6c490 } from "arc56-generated-algorandfoundation-algokit-utils-py";

const algorand = AlgorandClient.mainNet();
const client = new amm_03f6c490.ConstantProductAmmClient({
  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 | | --- | --- | --- | | amm_03f6c490 | ConstantProductAmmClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/amm_arc56_example/amm.arc56.json | | app_spec_ec5ae01b | DeleteAbiWithInnerClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/bare_create_abi_delete/app_spec.arc56.json | | large_95ebf552 | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/extra_pages_test/large.arc56.json | | small_6c2904ba | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/extra_pages_test/small.arc56.json | | nested_struct_223aa7f8 | NestedStructClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/nested_struct/nested_struct.arc56.json | | State_71647912 | StateClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/state_contract/State.arc56.json | | app_spec_52befe7f | TemplatesClient | https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/testing_app_arc56/app_spec.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.