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.0

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.0
File Size Uploaded Provenance Actions
aleo_contract_abi_generator-0.6.0.tar.gz 32.1 kB With provenance Details for aleo_contract_abi_generator-0.6.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for aleo-contract-abi-generator 0.6.0
File Actions
aleo_contract_abi_generator-0.6.0-cp37-abi3-win_amd64.whl CPython 3.7 abi3 Windows x86-64 Details for aleo_contract_abi_generator-0.6.0-cp37-abi3-win_amd64.whl
aleo_contract_abi_generator-0.6.0-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.0-cp37-abi3-manylinux_2_28_x86_64.whl
aleo_contract_abi_generator-0.6.0-cp37-abi3-manylinux_2_28_aarch64.whl CPython 3.7 abi3 Linux glibc 2.28+ ARM64 Details for aleo_contract_abi_generator-0.6.0-cp37-abi3-manylinux_2_28_aarch64.whl
aleo_contract_abi_generator-0.6.0-cp37-abi3-macosx_11_0_arm64.whl CPython 3.7 abi3 macOS 11.0+ ARM64 Details for aleo_contract_abi_generator-0.6.0-cp37-abi3-macosx_11_0_arm64.whl
aleo_contract_abi_generator-0.6.0-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.0-cp37-abi3-macosx_10_12_x86_64.whl

Total release size: 12.4 MB

Release files / aleo_contract_abi_generator-0.6.0.tar.gz

Download URL aleo_contract_abi_generator-0.6.0.tar.gz
Size 32.1 kB
Tags Source
SHA-256 checksum
How to use checksums
89dd7f6d1b941db525e24a20ded38659b36c53b2b235b8cb074bb992257b9991
BLAKE2b-256 checksum
How to use checksums
710ee8454f299ea1613c8edad71e022235cb508190758886609905481dcb81a5
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 1, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.6.0-cp37-abi3-win_amd64.whl
Size 2.2 MB
Tags CPython 3.7 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
5fdc9f324c67a8f59c0afb7af25c73c8b8e721d102cb3454b0af5bff963e535a
BLAKE2b-256 checksum
How to use checksums
6c91706b7718e8f878fbc355afdc5dc138b96585c4b9db4c9ff9df3cb433ed66
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 1, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.6.0-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
f2219eb3ff665c9beef3a97338825b58c4713e8d6ea30e05d855f5c3b274d9ac
BLAKE2b-256 checksum
How to use checksums
8aa25471146a7e5164f1053240cadc8d1bd1d5d14540805282516a4ad703db4c
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 1, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.6.0-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
5d10ac10c8009a90c5e6d147df0a902d20292e691bfbb3a60f0786ee2763858c
BLAKE2b-256 checksum
How to use checksums
0d582c1e5eb9cf6c01ec2cedb2679c4d49f74b6dfbade745d9cece728f023373
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 1, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.6.0-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
cd45603810a4a942106b8352f379b9e752e60225d62a34e75e2ed2137a3e7361
BLAKE2b-256 checksum
How to use checksums
79d6999698eb7159303cef7e5541235cec7dbf770a071e7c4e8527e8cac71d7f
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 1, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.6.0-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
6a9db9ec8e5bd5eef4984ffaa8aa0979235cf0789f7ce655bad7606409ad7f49
BLAKE2b-256 checksum
How to use checksums
e3bd4ab3dd294303e0643c66fa791299e9833915265dac80c334ced42358887f
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 1, 2026.

Transparency log

Security for aleo-contract-abi-generator 0.6.0

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.0.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 1, 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