API Reference bsv_sdk v#1.5.1

Copy Markdown View Source

Modules

BSV

BSV SDK for Elixir — a feature-complete Bitcoin SV toolkit.

HTTP client for the ARC API.

Configuration for an ARC client.

Error types for ARC operations.

ARC data types: status codes and API response structures.

Response from the ARC API.

BRC-31 identity certificate.

A master certificate with encrypted symmetric keys for each field.

Cryptographic nonce creation and verification for auth protocols.

A certificate with a verifier-specific keyring for selective field decryption.

Base58 and Base58Check encoding/decoding using the Bitcoin alphabet.

A Bitcoin block consisting of a BSV.BlockHeader and a list of transactions.

An 80-byte block header providing a summary of a Bitcoin block.

A 32-byte hash used for block and transaction identifiers in Bitcoin. Hex display follows Bitcoin convention (byte-reversed).

A behaviour and pipeline DSL for building Bitcoin locking and unlocking scripts.

Pipeline helpers for building scripts in BSV.Contract modules.

OP_RETURN output for placing arbitrary data on-chain.

Pay to Multi-Signature contract.

Pay to Public Key contract.

Pay to Public Key Hash contract.

Pay to R-Puzzle Hash contract.

Helpers for implementing OP_PUSH_TX in BSV.Contract modules.

Raw script contract — wraps a pre-built BSV.Script for use with the contract DSL.

Script-level VarInt helpers for BSV.Contract modules.

Cryptographic hash functions using OTP :crypto.

Pure-Elixir ECDSA signing on secp256k1 with RFC 6979 deterministic nonces.

RFC 6979 deterministic k generation using HMAC-DRBG (Section 3.2). Specialized for secp256k1 with SHA-256 (qlen = hlen = 256).

BIP-32 hierarchical deterministic (HD) extended keys.

HTTP client for the JungleBus API.

Configuration for a JungleBus client.

Error types for JungleBus operations.

JungleBus data types.

Address information returned by the JungleBus API.

A block header returned by the JungleBus API.

A transaction returned by the JungleBus API.

Convenience struct pairing a BSV.PrivateKey with its corresponding BSV.PublicKey.

BRC-78 message encryption and decryption.

BRC-77 message signing and verification.

BIP-39 mnemonic phrase generation and seed derivation.

Bitcoin private key operations: generation, WIF encoding, signing.

Bitcoin public key operations: derivation, compression, address generation, verification.

BEEF (Background Evaluation Extended Format) transaction container.

A transaction within a BEEF container.

Merkle path (BUMP) types and verification — BRC-74 binary format.

A single element in a Merkle path level.

Merkle tree parent computation using double-SHA256.

Bitcoin Script type — a sequence of opcodes and data pushes.

Bitcoin address handling for scripts.

Full Bitcoin script interpreter.

Bitcoin script opcode definitions.

Bitcoin script number encoding/decoding.

AES-256-GCM symmetric encryption.

STAS and STAS 3.0 token support for BSV.

Additional data attached to a STAS 3.0 action.

Multi-signature authority configuration for token governance.

STAS3 Bundle Factory — automatic merge/split/transfer transaction planning.

A destination for token transfer.

Token error types.

Contract transaction builder.

STAS transaction factories.

STAS3 transaction factories.

Build a BSV.Tokens.Stas3UnlockWitness (spec §7 slots 1-20) for a single STAS 3.0 input that the factory layer is about to sign.

STAS-BTG transaction factories.

Off-chain lineage validator for STAS tokens.

Owner address for token destinations — either a standard address (P2PKH) or a 20-byte MPKH (P2MPKH).

A UTXO payment input for token transactions.

Prev-TX split utility for Back-to-Genesis (BTG) proof system.

Token scheme defining the properties of a token.

Result of parsing a locking script.

Script reader for parsing STAS and STAS 3.0 locking scripts.

Builder for STAS 3.0 (stas3-freeze-multisig) locking scripts.

Fields extracted from a STAS 3.0 locking script.

STAS 3.0 v0.1 §8.1 / §9.5 atomic-swap and merge "piece array" trailing parameters for STAS 3.0 unlocking scripts.

Builder for STAS-BTG (Back-to-Genesis) locking scripts.

Builder for STAS locking scripts.

Fields extracted from a STAS v2 locking script.

Byte-pattern constants for classifying STAS script versions, plus builders for fixed locking-script bodies (such as the STAS 3.0 v0.1 §10.2 P2MPKH locking script).

STAS protocol flags field.

Classification of script types relevant to token operations.

Signing credentials for a UTXO — either a single key (P2PKH) or threshold keys with a multisig script (P2MPKH).

STAS protocol spending-type parameter.

End-to-end script-engine verification helper for STAS 3.0 transactions.

STAS 3.0 v0.1 §9 build-time enforcement helpers.

A destination specific to STAS 3.0 token operations.

Parameters for constructing a STAS 3.0 locking script.

Parameters for a STAS 3.0 output in spend operations.

STAS 3.0 spending operation type.

STAS 3.0 v0.1 §7 unlocking-script witness assembly (slots 1-20).

STAS 3.0 v0.1 §6.3 swap descriptor — the canonical, recursive form of the var2 payload pushed by an atomic-swap STAS UTXO (action byte 0x01).

STAS unlocking script templates (P2PKH and P2MPKH).

STAS3 unlocking script templates (P2PKH and P2MPKH).

STAS-BTG unlocking script template (Path A — BTG proof).

STAS-BTG checkpoint unlocking script template (Path B — Checkpoint attestation).

Token identifier derived from a BSV address.

A token input for STAS 3.0 spend operations.

STAS 3.0 v0.1 §8.1 transaction-type (txType) parameter.

Bitcoin SV transaction.

Pipe-friendly transaction builder.

Bitcoin transaction input.

Bitcoin transaction output.

Pay-to-Multiple-Public-Key-Hash (P2MPKH) signing template — STAS 3.0 v0.1 §10.2.

P2PKH signing template.

BIP-143 style signature hash computation for BSV (with FORKID).

Behaviour for transaction signing templates.

Bitcoin variable-length integer encoding/decoding.

The wallet behaviour — defines the interface for BSV wallet operations.

Wallet-specific error types.

BRC-42/43 key derivation.

A foundational wallet capable of cryptographic operations (key derivation, encrypt/decrypt, sign/verify, HMAC) but not transaction management or blockchain interaction.

Core wallet types: Protocol, Counterparty, EncryptionArgs, etc.

Counterparty in a cryptographic operation.

Common parameters for cryptographic operations.

Protocol identifier with security level and name.