arc56-generated-algorandfoundation-devportal-code-examples
v1.5.2026082221
Published
Generated ARC-56 Algorand smart-contract clients for algorandfoundation/devportal-code-examples.
Downloads
304
Maintainers
Readme
arc56-generated-algorandfoundation-devportal-code-examples
Auto-generated typed Algorand smart-contract clients for algorandfoundation/devportal-code-examples, 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-devportal-code-examples @algorandfoundation/algokit-utils algosdkBasic 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 { Arc4DynamicArray_82c0c5a1 } from "arc56-generated-algorandfoundation-devportal-code-examples";
const algorand = AlgorandClient.mainNet();
const client = new Arc4DynamicArray_82c0c5a1.Arc4DynamicArrayClient({
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 |
| --- | --- | --- |
| Arc4DynamicArray_82c0c5a1 | Arc4DynamicArrayClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/arc4_types/Arc4DynamicArray.arc56.json |
| Arc4StaticArray_91266734 | Arc4StaticArrayClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/arc4_types/Arc4StaticArray.arc56.json |
| Arc4Struct_ce5efd08 | Arc4StructClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/arc4_types/Arc4Struct.arc56.json |
| Arc4Tuple_d9fb5142 | Arc4TupleClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/arc4_types/Arc4Tuple.arc56.json |
| Arc4Types_84270f0a | Arc4TypesClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/arc4_types/Arc4Types.arc56.json |
| BoxStorage_d1bc697d | BoxStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/box_storage/BoxStorage.arc56.json |
| ForLoopsExample_310ba38f | ForLoopsExampleClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.arc56.json |
| IfElseExample_b287b0b6 | IfElseExampleClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/control_flow/IfElseExample.arc56.json |
| MatchStatements_4de1ba22 | MatchStatementsClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/control_flow/MatchStatements.arc56.json |
| WhileLoopExample_4f770493 | WhileLoopExampleClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/control_flow/WhileLoopExample.arc56.json |
| CustomCreate_0a6e344b | CustomCreateClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/custom_create/CustomCreate.arc56.json |
| GlobalStorage_1715111a | GlobalStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/global_storage/GlobalStorage.arc56.json |
| HelloWorld_f1c8a653 | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/hello_world/HelloWorld.arc56.json |
| InnerTransactions_100b565e | InnerTransactionsClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/inner_transactions/InnerTransactions.arc56.json |
| LocalStorage_dc42642b | LocalStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/local_storage/LocalStorage.arc56.json |
| ReferenceAccount_d0122bff | ReferenceAccountClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_account/ReferenceAccount.arc56.json |
| MyCounter_8c222537 | MyCounterClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_account_app/MyCounter.arc56.json |
| ReferenceAccountApp_6a8fd334 | ReferenceAccountAppClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_account_app/ReferenceAccountApp.arc56.json |
| ReferenceAccountAsset_874d8404 | ReferenceAccountAssetClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_account_asset/ReferenceAccountAsset.arc56.json |
| Counter_ee446662 | CounterClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_app/Counter.arc56.json |
| ReferenceApp_155c0806 | ReferenceAppClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_app/ReferenceApp.arc56.json |
| ReferenceAppBox_ede6a6b9 | ReferenceAppBoxClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_app_box/ReferenceAppBox.arc56.json |
| ReferenceAsset_279002c9 | ReferenceAssetClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/reference_asset/ReferenceAsset.arc56.json |
| StructInBoxMap_6c1dc1af | StructInBoxMapClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/python-examples/smart_contracts/artifacts/struct_in_box/StructInBoxMap.arc56.json |
| BoxStorage_d2f79831 | BoxStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/BoxStorage/BoxStorage.arc56.json |
| ControlFlow_6df31762 | ControlFlowClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ControlFlow/ControlFlow.arc56.json |
| Counter_fe501ea2 | CounterClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/Counter/Counter.arc56.json |
| CustomCreate_38af1583 | CustomCreateClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/CustomCreate/CustomCreate.arc56.json |
| GlobalStorage_e9cecc7a | GlobalStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/GlobalStorage/GlobalStorage.arc56.json |
| HelloWorld_7927f005 | HelloWorldClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/HelloWorld/HelloWorld.arc56.json |
| InnerTransactions_0998f241 | InnerTransactionsClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/InnerTransactions/InnerTransactions.arc56.json |
| LocalStorage_5b462e6d | LocalStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/LocalStorage/LocalStorage.arc56.json |
| ReferenceAccount_e51cb649 | ReferenceAccountClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAccount/ReferenceAccount.arc56.json |
| MyCounter_f3a03156 | MyCounterClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAccountApp/MyCounter.arc56.json |
| ReferenceAccountApp_d76d667e | ReferenceAccountAppClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAccountApp/ReferenceAccountApp.arc56.json |
| ReferenceAccountAsset_a7d7be9f | ReferenceAccountAssetClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAccountAsset/ReferenceAccountAsset.arc56.json |
| Counter_c26ca508 | CounterClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceApp/Counter.arc56.json |
| ReferenceApp_15de5089 | ReferenceAppClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceApp/ReferenceApp.arc56.json |
| ReferenceAppBox_fcd3701e | ReferenceAppBoxClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAppBox/ReferenceAppBox.arc56.json |
| ReferenceAsset_d5ba42b5 | ReferenceAssetClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ReferenceAsset/ReferenceAsset.arc56.json |
| ScratchStorage_57d9ca58 | ScratchStorageClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/ScratchStorage/ScratchStorage.arc56.json |
| SelfPayment_1a46cc59 | SelfPaymentClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/SelfPayment/SelfPayment.arc56.json |
| StructInBoxMap_508553b3 | StructInBoxMapClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/StructInBox/StructInBoxMap.arc56.json |
| SubsidizeAppCall_f2e278dd | SubsidizeAppCallClient | https://raw.githubusercontent.com/algorandfoundation/devportal-code-examples/HEAD/projects/typescript-examples/contracts/artifacts/contracts/SubsidizeAppCall/SubsidizeAppCall.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.
