clearnet-sdk

module

v0.2.0 Latest Latest Go to latest Published: Jun 19, 2026 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/layer-3/clearnet-sdk

Links

Open Source Insights

README ¶

clearnet-sdk

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
devnet
wait command Command wait blocks until every devnet node answers RPC, then exits 0 — so `make devnet` returns only once the infra is ready to drive.	Command wait blocks until every devnet node answers RPC, then exits 0 — so `make devnet` returns only once the infra is ready to drive.
pkg
abiutil Package abiutil provides shared ABI type singletons parsed once at init.	Package abiutil provides shared ABI type singletons parsed once at init.
blockchain/btc Package btc implements the Bitcoin custody vault adapter.	Package btc implements the Bitcoin custody vault adapter.
blockchain/evm Package evm implements the chain-agnostic adapter interfaces (see pkg/core) against an EVM chain, one focused type per concern: Depositor and WithdrawalFinalizer (the vault money path), plus RegistryAdapter, TokenAdapter, FraudAdapter, and FaucetAdapter.	Package evm implements the chain-agnostic adapter interfaces (see pkg/core) against an EVM chain, one focused type per concern: Depositor and WithdrawalFinalizer (the vault money path), plus RegistryAdapter, TokenAdapter, FraudAdapter, and FaucetAdapter.
blockchain/evm/abi_refresher command Command abi_refresher regenerates the EVM contract bindings (the `pkg/blockchain/evm/*_abi.go` files) from the vendored ABI + bytecode files under `pkg/blockchain/evm/artifacts/`, using go-ethereum's abigen library directly — no bash, no jq, no external abigen binary, no forge build.	Command abi_refresher regenerates the EVM contract bindings (the `pkg/blockchain/evm/*_abi.go` files) from the vendored ABI + bytecode files under `pkg/blockchain/evm/artifacts/`, using go-ethereum's abigen library directly — no bash, no jq, no external abigen binary, no forge build.
blockchain/sol Package sol implements the chain-agnostic adapter interfaces (see pkg/core) against Solana, over the custody Anchor program.	Package sol implements the chain-agnostic adapter interfaces (see pkg/core) against Solana, over the custody Anchor program.
blockchain/sol/custody
blockchain/sol/idl_refresher command Command idl_refresher regenerates the Solana program bindings (the pkg/blockchain/sol/custody package) from the vendored Anchor IDL using anchor-go's generator library directly — the Solana analog of the EVM abi_refresher (which drives go-ethereum's abigen).	Command idl_refresher regenerates the Solana program bindings (the pkg/blockchain/sol/custody package) from the vendored Anchor IDL using anchor-go's generator library directly — the Solana analog of the EVM abi_refresher (which drives go-ethereum's abigen).
blockchain/xrpl Package xrpl implements the XRP Ledger custody vault via Peersyst/xrpl-go: a depositor that sends tagged Payments, and a multi-sign withdrawal finalizer over a SignerList-configured vault account.	Package xrpl implements the XRP Ledger custody vault via Peersyst/xrpl-go: a depositor that sends tagged Payments, and a multi-sign withdrawal finalizer over a SignerList-configured vault account.
bls
cborx Package cborx provides shared primitive-adapter codecs for the canonical deterministic CBOR (RFC 8949 §4.2) encoding used across the Yellow Network protocol.	Package cborx provides shared primitive-adapter codecs for the canonical deterministic CBOR (RFC 8949 §4.2) encoding used across the Yellow Network protocol.
core This file exists solely to anchor the `go generate` directive that produces pkg/core/cbor_gen.go.	This file exists solely to anchor the `go generate` directive that produces pkg/core/cbor_gen.go.
core/gen command Package main is the cbor-gen driver for pkg/core.	Package main is the cbor-gen driver for pkg/core.
decimal Package decimal — CBOR adapter methods for decimal.Decimal.	Package decimal — CBOR adapter methods for decimal.Decimal.
eip712 Package eip712 provides shared EIP-712 signature verification for both the gateway (HTTP->TCP relay) and the clearnode (TCP command verification).	Package eip712 provides shared EIP-712 signature verification for both the gateway (HTTP->TCP relay) and the clearnode (TCP command verification).
log Package log provides a structured, context-aware logging system with distributed tracing support.	Package log provides a structured, context-aware logging system with distributed tracing support.
p2p/auth Package auth implements the /ynp/auth/1.0.0 libp2p handshake that lets a node prove who it is before a peer accepts its restricted streams (notably the burn/mint receipt protocols).	Package auth implements the /ynp/auth/1.0.0 libp2p handshake that lets a node prove who it is before a peer accepts its restricted streams (notably the burn/mint receipt protocols).
p2p/protocol Package protocol defines the canonical libp2p wire contract: the stream protocol identifiers, the GossipSub topic names, and the framed message structs that travel over them.	Package protocol defines the canonical libp2p wire contract: the stream protocol identifiers, the GossipSub topic names, and the framed message structs that travel over them.
p2p/pubsub Package pubsub is a generic GossipSub publish/subscribe toolset over any cborx-envelope payload: a Publisher[T]/Follower[T] works for any T whose cbor-gen codec lives on *T (e.g.	Package pubsub is a generic GossipSub publish/subscribe toolset over any cborx-envelope payload: a Publisher[T]/Follower[T] works for any T whose cbor-gen codec lives on *T (e.g.
p2p/receipt Package receipt implements the libp2p request/response stream protocols for burn/mint receipt submission.	Package receipt implements the libp2p request/response stream protocols for burn/mint receipt submission.
receipt
sign Package sign abstracts signing identities behind a pluggable, algorithm-aware interface — raw in-memory keys for clients/CLI/tests, KMS backends in production (custody's AWS/GCP signers satisfy this interface unchanged).	Package sign abstracts signing identities behind a pluggable, algorithm-aware interface — raw in-memory keys for clients/CLI/tests, KMS backends in production (custody's AWS/GCP signers satisfy this interface unchanged).