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.

The validation rules are those of the snarkVM release Leo pins, which can trail the main SDK's by one release. Right now this package validates with snarkVM 4.11.0 while aleo-sdk uses 4.12.0: a program with more than 31 mappings, which consensus V22 allows (live on testnet, mainnet from block 22,962,000), parses in the main SDK but is rejected here with "Program exceeds the maximum number of mappings" until Leo moves to 4.12.

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.7.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.7.0
File Size Uploaded Provenance Actions
aleo_contract_abi_generator-0.7.0.tar.gz 32.4 kB With provenance Details for aleo_contract_abi_generator-0.7.0.tar.gz

Built distributions (wheels)

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

Total release size: 12.4 MB

Release files / aleo_contract_abi_generator-0.7.0.tar.gz

Download URL aleo_contract_abi_generator-0.7.0.tar.gz
Size 32.4 kB
Tags Source
SHA-256 checksum
How to use checksums
be55adc8c1e61af4d7da13cf1a5c3c853ed915cc69af8956054dd171e7e52aec
BLAKE2b-256 checksum
How to use checksums
ce3807e4a838a135828f0a6603065cc0590eac79e385ad1d185e312efc64668a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.7.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
ac15cce2a52286efd61e3b3950030840e147c83cfcbb2da7b8e7767a09443f18
BLAKE2b-256 checksum
How to use checksums
2bfa73dc6f55bcf1fd8c543d2d982c2ab184300c7392318c9481e521e3beab04
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.7.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
b9fe7578333ea2ada0db5658b027d6e1d259fb74e15740d8cdf9f220b14be1c3
BLAKE2b-256 checksum
How to use checksums
82333e5f4aedf3dd1d0d588f3a168dd05958097118e3bbc9693a05f383551fc1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.7.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
3014483543468bae3ae4d6c5c97fd94b9fbdec9195278df26bb4ff5ec560cd24
BLAKE2b-256 checksum
How to use checksums
8f9a420b763b23cc7b646996b4f351ac835a2a325fa74560f4c93e7e3f29b866
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.7.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
6617f087dbd3ab45720fa5fa90ccdcc4a87bc2dcaa64c8de7a04d484f509d233
BLAKE2b-256 checksum
How to use checksums
aa5646ca854be51750d27e340b5cfd17257269b3298dbe4ea454ea396a577d2d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

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

Download URL aleo_contract_abi_generator-0.7.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
26555671c6dccc57070d4c342164f04d3d5c5c7b710a438cad841eb5a374477e
BLAKE2b-256 checksum
How to use checksums
67c66dfa8db6185460739e583c2b7e85155163107e6c58270e7872bebc46f0a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 22, 2026.

Transparency log

Security for aleo-contract-abi-generator 0.7.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.7.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 22, 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