go

module

v0.2.0 Latest Latest Go to latest Published: Sep 16, 2026 License: Apache-2.0

Directories ¶

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

Path	Synopsis
address Package address validates SOVR account addresses (FR-014) and derives test-only addresses from BIP39 mnemonics (FR-015).	Package address validates SOVR account addresses (FR-014) and derives test-only addresses from BIP39 mnemonics (FR-015).
amounts Package amounts converts between SOVR display amounts and usovr base units with exact integer arithmetic (FR-017/FR-018).	Package amounts converts between SOVR display amounts and usovr base units with exact integer arithmetic (FR-017/FR-018).
client Package client is the kit's chain-access layer: one Client interface served by two transports — gRPC against an exchange-run node (NewGRPC) and a CometBFT-RPC fallback that tunnels service queries through abci_query (NewCometRPC; R4/R8) — plus a health-checked failover wrapper (NewFailover) and the network-manifest loader (LoadManifest).	Package client is the kit's chain-access layer: one Client interface served by two transports — gRPC against an exchange-run node (NewGRPC) and a CometBFT-RPC fallback that tunnels service queries through abci_query (NewCometRPC; R4/R8) — plus a health-checked failover wrapper (NewFailover) and the network-manifest loader (LoadManifest).
cmd
sovren-adapter command Command sovren-adapter is the runnable reference adapter (contract: go-client-api.md §cmd/sovren-adapter): one binary hosting the scanner / withdrawals / sweeper / reconciler services plus the Prometheus and admin listeners.	Command sovren-adapter is the runnable reference adapter (contract: go-client-api.md §cmd/sovren-adapter): one binary hosting the scanner / withdrawals / sweeper / reconciler services plus the Prometheus and admin listeners.
sovren-cert command Command sovren-cert is the Sovren Technical Integration Certification suite — it certifies the exchange's technical integration only, never the exchange's compliance, custody, or legal posture (contract: specs/008-exchange-integration-kit/contracts/certification.md; data model §13).	Command sovren-cert is the Sovren Technical Integration Certification suite — it certifies the exchange's technical integration only, never the exchange's compliance, custody, or legal posture (contract: specs/008-exchange-integration-kit/contracts/certification.md; data model §13).
sovren-exec-signer-demo command sovren-exec-signer-demo — the bundled reference `exec` signer (contracts/signer-interface.md §Remote signer transports): one JSON request on stdin, one JSON response on stdout, non-zero exit with {"error_code": …} on failure.	sovren-exec-signer-demo — the bundled reference `exec` signer (contracts/signer-interface.md §Remote signer transports): one JSON request on stdin, one JSON response on stdout, non-zero exit with {"error_code": …} on failure.
sovren-manifest command Command sovren-manifest generates and verifies the kit's network manifests (contracts/network-manifest.md).	Command sovren-manifest generates and verifies the kit's network manifests (contracts/network-manifest.md).
sovren-vectors command sovren-vectors — deterministic test-vector tooling (contracts/test-vectors.md).	sovren-vectors — deterministic test-vector tooling (contracts/test-vectors.md).
deposits Package deposits is the kit's deposit-scanning core (contracts/ go-client-api.md §deposits, R6): tolerant block parsing and watch-set classification into the ChainTransferLedger (parse.go), FR-023 credit-condition evaluation and the transactional block/credit write paths (state.go), and the checkpointed ascending scanner engine (scanner.go).	Package deposits is the kit's deposit-scanning core (contracts/ go-client-api.md §deposits, R6): tolerant block parsing and watch-set classification into the ChainTransferLedger (parse.go), FR-023 credit-condition evaluation and the transactional block/credit write paths (state.go), and the checkpointed ascending scanner engine (scanner.go).
gen
sovr/globalfee/v1
sovr/txquery/v1
sovren/signer/v1
internal
logging Package logging provides the kit's structured JSON logging base (FR-050).	Package logging provides the kit's structured JSON logging base (FR-050).
metrics Package metrics is the kit's Prometheus instrument set: the full contracts/metrics.md contract (T007 skeleton + T066 completion) — the PRD §31.1 names verbatim plus the operational extras, all carrying chain_id.	Package metrics is the kit's Prometheus instrument set: the full contracts/metrics.md contract (T007 skeleton + T066 completion) — the PRD §31.1 names verbatim plus the operational extras, all carrying chain_id.
reconcile Package reconcile is the kit's reconciliation engine (T063; FR-046–FR-048, data model §8/§8a):	Package reconcile is the kit's reconciliation engine (T063; FR-046–FR-048, data model §8/§8a):
sequences Package sequences is the kit's durable sequence manager (FR-034, data model §6).	Package sequences is the kit's durable sequence manager (FR-034, data model §6).
signer Package signer defines the kit's external signing boundary — the single interface between transaction construction and key material (FR-012, FR-021, FR-061).	Package signer defines the kit's external signing boundary — the single interface between transaction construction and key material (FR-012, FR-021, FR-061).
execsigner Package execsigner is the adapter's `exec` signer transport: a one-shot subprocess per request with a JSON request on stdin and a JSON response on stdout (bytes base64-encoded), suiting air-gap bridges and custom HSM shims (contract: signer-interface.md §Remote signer transports).	Package execsigner is the adapter's `exec` signer transport: a one-shot subprocess per request with a JSON request on stdin and a JSON response on stdout (bytes base64-encoded), suiting air-gap bridges and custom HSM shims (contract: signer-interface.md §Remote signer transports).
grpcremote Package grpcremote is the adapter's `grpc-remote` signer transport: a signer.TransactionSigner client for the sovren.signer.v1.SignerService an exchange's signing system implements (contract: signer-interface.md §Remote signer transports).	Package grpcremote is the adapter's `grpc-remote` signer transport: a signer.TransactionSigner client for the sovren.signer.v1.SignerService an exchange's signing system implements (contract: signer-interface.md §Remote signer transports).
local Package local is the in-memory secp256k1 TransactionSigner (adapter kind "unsafe-local").	Package local is the in-memory secp256k1 TransactionSigner (adapter kind "unsafe-local").
storage Package storage defines the kit's persistence contract: shared domain types mirroring specs/008-exchange-integration-kit/data-model.md and the repository interfaces implemented by storage/sqlite and storage/postgres.	Package storage defines the kit's persistence contract: shared domain types mirroring specs/008-exchange-integration-kit/data-model.md and the repository interfaces implemented by storage/sqlite and storage/postgres.
internal/sqlstore Package sqlstore is the shared database/sql implementation of the storage.Store contract.	Package sqlstore is the shared database/sql implementation of the storage.Store contract.
internal/storetest Package storetest is the backend-agnostic conformance suite for storage.Store implementations.	Package storetest is the backend-agnostic conformance suite for storage.Store implementations.
migrations Package migrations embeds the kit's SQL schema, one file set per dialect.	Package migrations embeds the kit's SQL schema, one file set per dialect.
postgres Package postgres provides the kit's production storage backend over pgx/v5's database/sql driver (R7).	Package postgres provides the kit's production storage backend over pgx/v5's database/sql driver (R7).
sqlite Package sqlite provides the kit's default, CGO-free storage backend over modernc.org/sqlite (R7).	Package sqlite provides the kit's default, CGO-free storage backend over modernc.org/sqlite (R7).
sweeps Package sweeps implements the data-model §7 sweep state machine over storage.Store with withdrawal-grade durability (FR-037–039):	Package sweeps implements the data-model §7 sweep state machine over storage.Store with withdrawal-grade durability (FR-037–039):
tx Package tx builds, signs (via external signers), and assembles single-MsgSend SOVR transactions under SIGN_MODE_DIRECT (contracts/go-client-api.md §tx).	Package tx builds, signs (via external signers), and assembles single-MsgSend SOVR transactions under SIGN_MODE_DIRECT (contracts/go-client-api.md §tx).
withdrawals Package withdrawals implements the data-model §5 withdrawal state machine over storage.Store: the FR-032 pre-sign checklist, the externally supplied compliance gate, idempotency-key single execution (FR-033), simulation and ceiling-rounded fee calculation (FR-040), and the FR-035 broadcaster (broadcast.go) with its eight status distinctions.	Package withdrawals implements the data-model §5 withdrawal state machine over storage.Store: the FR-032 pre-sign checklist, the externally supplied compliance gate, idempotency-key single execution (FR-033), simulation and ceiling-rounded fee calculation (FR-040), and the FR-035 broadcaster (broadcast.go) with its eight status distinctions.