Skip to main content

aleo-contract-abi-generator

Generates a JSON ABI from deployed Aleo bytecode, and checks one ABI against another for compatibility. Rust bindings around Leo's ABI generation with full snarkVM validation — a program that does not validate does not get an ABI. Everything runs locally; nothing touches the network.

The distribution is aleo-contract-abi-generator; the import module is aleo_abi.

import aleo_abi

abi_json = aleo_abi.generate_abi("simple.aleo", bytecode, "testnet", None)
violations = aleo_abi.check_compatibility(candidate_json, standard_json)

Install

pip install aleo-contract-abi-generator

Most callers want the friendlier hook in the main SDK instead — aleo.abi.generate_abi accepts a Program object or a raw bytecode string, infers the program name, and returns a dict:

from aleo import abi
from aleo.mainnet import Program

result = abi.generate_abi(Program.credits())
result["program"]        # "credits.aleo"

The hook imports this package lazily and raises ImportError with the install command if it is absent — the main SDK does not depend on it.

Generating an ABI

generate_abi(program_name, bytecode, network, imports) returns a pretty-printed JSON string describing the program: its structs, records, mappings, and functions, each field carrying a structured type ({"Primitive": {"Int": "I32"}}, record ownership, visibility).

snarkVM validation is contextual: a program that declares imports is rejected unless those imports are supplied. Pass them as (program_id, bytecode) pairs in topological order — dependencies before dependents:

abi_json = aleo_abi.generate_abi(
    "shield_swap.aleo", amm_bytecode, "testnet",
    [("shield_swap_multisig_core.aleo", multisig_bytecode),
     ("shield_swap_freezelist.aleo", freezelist_bytecode)],
)

network is "mainnet", "testnet", or "canary" — it selects the validation rules, not a connection.

Checking compatibility

check_compatibility(candidate_abi_json, standard_abi_json) returns a list of violation strings — empty means the candidate satisfies the standard. Use it to pin a deployed contract's surface and fail your CI when the deployment drifts, instead of your consumers:

violations = aleo_abi.check_compatibility(deployed_abi, pinned_abi)
assert not violations, "\n".join(violations)

This is how shield-swap-sdk's live drift test guards its committed bindings (codegen/regen-abi.sh regenerates the pin from the deployed program).

Downstream: generated Python bindings

The ABI JSON is the input format for the main SDK's aleo.codegen, which emits typed dataclasses and entrypoint stubs from it:

python -m aleo.codegen --abi shield_swap.abi.json --out _generated.py

Tests

cd sdk-abi && python -m pytest python/tests -v   # hermetic — no network

Fixtures and expected ABIs are vendored from Leo's own test suite, so the output shape is pinned to upstream.

Metadata

Release files for aleo-contract-abi-generator 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aleo-contract-abi-generator 0.6.1
File Size Uploaded Provenance Actions
aleo_contract_abi_generator-0.6.1.tar.gz 32.1 kB With provenance Details for aleo_contract_abi_generator-0.6.1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for aleo-contract-abi-generator 0.6.1
File Actions
aleo_contract_abi_generator-0.6.1-cp37-abi3-win_amd64.whl CPython 3.7 abi3 Windows x86-64 Details for aleo_contract_abi_generator-0.6.1-cp37-abi3-win_amd64.whl
aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_x86_64.whl CPython 3.7 abi3 Linux glibc 2.28+ x86-64 Details for aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_x86_64.whl
aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_aarch64.whl CPython 3.7 abi3 Linux glibc 2.28+ ARM64 Details for aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_aarch64.whl
aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_11_0_arm64.whl CPython 3.7 abi3 macOS 11.0+ ARM64 Details for aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_11_0_arm64.whl
aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_10_12_x86_64.whl CPython 3.7 abi3 macOS 10.12+ x86-64 Details for aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_10_12_x86_64.whl

Total release size: 12.4 MB

Release files / aleo_contract_abi_generator-0.6.1.tar.gz

Download URL aleo_contract_abi_generator-0.6.1.tar.gz
Size 32.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4f51236ade16af78971649e69aba9e02333bc029855a9a6b38d5f2d4184aa9ca
BLAKE2b-256 checksum
How to use checksums
d192c4171a9a4aaedf531ae01c4037a520f92e36e2d79167e5e9249c4fdbe321
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / aleo_contract_abi_generator-0.6.1-cp37-abi3-win_amd64.whl

Download URL aleo_contract_abi_generator-0.6.1-cp37-abi3-win_amd64.whl
Size 2.2 MB
Tags CPython 3.7 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
4c1e886025236a9bf8c8b713c20e746d75e0434c8232596fb70340471a68b2ec
BLAKE2b-256 checksum
How to use checksums
13ab84f9af3486d6cf4fda028b30556ab614c569ea76709b8bd12281247c85bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_x86_64.whl

Download URL aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_x86_64.whl
Size 2.6 MB
Tags CPython 3.7 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
821236cc0a0df05bc327ac70dc9efcb9412376ad32592cdafafd379e40366bc9
BLAKE2b-256 checksum
How to use checksums
7960ee9880c67b25a77652708ed96a1b1f3e3634184b89af3a13cd592caf7926
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_aarch64.whl

Download URL aleo_contract_abi_generator-0.6.1-cp37-abi3-manylinux_2_28_aarch64.whl
Size 2.7 MB
Tags CPython 3.7 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
bb515c22cc64a62e54548735c4c25537265f8e1df557f43f3cd523156f5da4f0
BLAKE2b-256 checksum
How to use checksums
04ad18f61ff20f235877054f1b25f338798cbb7dc557df26b3ae06d33c4f7cfe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_11_0_arm64.whl

Download URL aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_11_0_arm64.whl
Size 2.4 MB
Tags CPython 3.7 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
3e3b5b368dc136e06b4a7a636dd7b0705b7cc011dbc209cb8d1b6242286c3e8a
BLAKE2b-256 checksum
How to use checksums
98c3b15858bec2513f17b87cc447c2dd315e70a5d10cadb0227016723435fbe3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_10_12_x86_64.whl

Download URL aleo_contract_abi_generator-0.6.1-cp37-abi3-macosx_10_12_x86_64.whl
Size 2.5 MB
Tags CPython 3.7 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
c6c77dc85ebe0c74f0367300c5ad9fd26a985e5d07576ebe5444f511af51c26a
BLAKE2b-256 checksum
How to use checksums
595799682913de9009f997426f7473b7975b067ff137e60e2f6d01a0541665ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Security for aleo-contract-abi-generator 0.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for aleo_contract_abi_generator-0.6.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page