Metadata-Version: 2.5
Name: arc56-generated-algor_cf67f71f
Version: 1.3.2026072710
Summary: Generated ARC-56 Algorand smart-contract clients for algorandfoundation/algokit-client-generator-ts.
Project-URL: Homepage, https://github.com/scholtz/Arc56Registry
Project-URL: Repository, https://github.com/scholtz/Arc56Registry
Author: algorandfoundation
Keywords: algokit-client-generator-ts,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_cf67f71f

Auto-generated typed Algorand smart-contract clients for **[algorandfoundation/algokit-client-generator-ts](https://github.com/algorandfoundation/algokit-client-generator-ts)**,
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_cf67f71f
```

## 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_cf67f71f import Arc56Test_ab61f4ea

algorand = AlgorandClient.mainnet()
client = Arc56Test_ab61f4ea.Arc56TestClient(
    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 |
| --- | --- | --- |
| `Arc56Test_ab61f4ea` | `Arc56TestClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/arc56_test/Arc56Test.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/arc56_test/Arc56Test.arc56.json) |
| `Nested_a5553c5e` | `NestedClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/nested/Nested.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/nested/Nested.arc56.json) |
| `Nfd_b82e46be` | `NfdInstanceClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/nfd/Nfd.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/nfd/Nfd.arc56.json) |
| `Reti_cb1e912a` | `ValidatorRegistryClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/reti/Reti.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/reti/Reti.arc56.json) |
| `Structs_0f740f2e` | `StructsClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/structs/Structs.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/structs/Structs.arc56.json) |
| `Void_d358dd5e` | `VoidClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/void/Void.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/void/Void.arc56.json) |
| `ZeroCouponBond_4ab39cf3` | `ZeroCouponBondClient` | [https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/zero_coupon_bond/ZeroCouponBond.arc56.json](https://raw.githubusercontent.com/algorandfoundation/algokit-client-generator-ts/HEAD/examples/smart_contracts/artifacts/zero_coupon_bond/ZeroCouponBond.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.
