Metadata-Version: 2.5
Name: arc56-generated-algor_e47169c2
Version: 1.2.2026072010
Summary: Generated ARC-56 Algorand smart-contract clients for algorandfoundation/algokit-utils-py.
Project-URL: Homepage, https://github.com/scholtz/Arc56Registry
Project-URL: Repository, https://github.com/scholtz/Arc56Registry
Author: algorandfoundation
Keywords: algokit-utils-py,algorand,algorandfoundation,arc56,avm,generated-client,smart-contract
Requires-Python: >=3.10
Requires-Dist: algokit-utils<5.0.0,>=4.2.3
Requires-Dist: py-algorand-sdk<3.0.0,>=2.11.1
Description-Content-Type: text/markdown

# arc56-generated-algor_e47169c2

Auto-generated typed Algorand smart-contract clients for **[algorandfoundation/algokit-utils-py](https://github.com/algorandfoundation/algokit-utils-py)**,
built from the [ARC-56](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0056.md)
specs listed below.

Generated by the [Arc56Registry](https://github.com/scholtz/Arc56Registry) pipeline,
using the [algorandfoundation/algokit-client-generator-py](https://github.com/algorandfoundation/algokit-client-generator-py)
ARC-56 client generator. Do not edit these files by hand — they are regenerated
automatically whenever the source ARC-56 spec changes.

## Install

```bash
pip install arc56-generated-algor_e47169c2
```

## Basic usage

Each contract in this package is a separate module (a hash of its source URL is
appended to its filename 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.

```python
from algokit_utils import AlgorandClient
from arc56_generated_algor_e47169c2 import amm_03f6c490

algorand = AlgorandClient.mainnet()
client = amm_03f6c490.ConstantProductAmmClient(
    algorand=algorand,
    app_id=123456789,
)

# call a contract method, e.g.:
# result = client.send.some_method(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 plus
deployment metadata (source code, bytecode, template variables). For the rare contract
whose `full`-mode output fails to generate or fails to byte-compile, this package falls
back to `minimal` mode (`Client` only, no `Factory`) for that contract 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

| Module | 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](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](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](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](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](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](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](https://raw.githubusercontent.com/algorandfoundation/algokit-utils-py/HEAD/tests/artifacts/testing_app_arc56/app_spec.arc56.json) |

## Versioning

This package uses `1.<increment>.<yyyyMMddHH>`-style versioning: a new version is
published whenever any of the contracts above change, or whenever the client generator
itself is updated. See [Arc56Registry](https://github.com/scholtz/Arc56Registry) for
the full generation pipeline and source ARC-56 registry.
