Contracts Bindings

This directory contains generated contract bindings and ABIs for the Pell Network contracts.

Structure

• abis/ - Contract ABIs generated from Solidity contracts (via hardhat-abi-exporter)
• pkg/ - Go bindings generated from contract artifacts
• go.mod - Go module dependencies
• go.sum - Go module checksums

How it works

1. ABI Generation: When contracts are compiled, the hardhat-abi-exporter plugin automatically exports ABIs to this directory's abis/ folder
2. Go Binding Generation: The generate_go.sh script (in parent repo) reads contract artifacts and generates Go bindings in the pkg/ directory
3. Submodule Updates: Changes are automatically committed to this submodule when contracts are updated

Usage

From Parent Repository

To generate and update bindings from the parent repository:

# Generate Go bindings and update submodule
yarn generate-bindings

# Or just update existing bindings
yarn update-bindings

Manual Generation

If you need to manually generate Go bindings:

# From parent repository root
./scripts/generate_go.sh

Requirements

• Go 1.22+
• abigen tool (part of go-ethereum)
• jq for JSON processing

Integration

This submodule is automatically updated when:

• New contracts are deployed
• Contract ABIs are updated
• The main repository is released

The parent repository references this submodule and includes it in deployments and CI/CD pipelines.