# BSV blockchain > Developer documentation for the BSV blockchain: build apps with BRC-100 wallets and the TypeScript SDK. ## Get started ### Build your first app - [Send a payment from a web app](https://bsvblockchain.com/docs/get-started/quick-start-browser.md): Set up a testnet wallet on the BSV blockchain, connect an app to it with the TypeScript SDK, and send a first payment without putting a private key in your code. - [Send a payment from a server](https://bsvblockchain.com/docs/get-started/quick-start-server.md): Run a BSV blockchain server wallet with local storage on testnet, fund it once from BSV Desktop, and send a payment from it with no person approving. - [Verify your payment on the explorer](https://bsvblockchain.com/docs/get-started/verify.md): Check a BSV blockchain testnet payment you already sent on the explorer, from unconfirmed to confirmed, and read the fee it paid. - [Start a project from a template](https://bsvblockchain.com/docs/get-started/project-starter.md): Generate a React app with create-bsv-app that already connects to BSV Desktop, run it on testnet, and find the code that makes the connection. - [Try the BSV blockchain in your browser](https://bsvblockchain.com/docs/get-started/try-it.md): Look up a transaction on the BSV blockchain testnet and inspect its BEEF on this page, with nothing to install and no wallet. ### Set up your AI - [Coding with agents](https://bsvblockchain.com/docs/build-with-ai.md): Set up an AI coding agent to build BSV blockchain apps the way these docs describe, with the BSV blockchain docs server, the bsv-dev skill and @bsv/mcp, on testnet. - [Connect your AI tool with MCP](https://bsvblockchain.com/docs/build-with-ai/mcp.md): Give Claude Code the BSV blockchain docs and the @bsv/mcp tools through MCP servers, so your agent reads these pages, checks BSV Broadcaster and reviews your project on testnet. - [Install the BSV blockchain agent skill](https://bsvblockchain.com/docs/build-with-ai/skill.md): Install the bsv-dev skill or the Claude Code plugin, so your agent builds BSV blockchain apps the way these docs do, on testnet. - [Start from the tipping sample](https://bsvblockchain.com/docs/build-with-ai/tipping-sample.md): Run BSV Association's tipping sample on testnet: each user's wallet holds the keys, and a relay with no key passes tips to BSV Broadcaster. - [Send a payment with an AI agent](https://bsvblockchain.com/docs/build-with-ai/prompts.md): Have an AI agent build and run a first testnet payment from the BSV blockchain docs, while you give it your address and approve the payment in BSV Desktop. - [Give agents the docs in Markdown](https://bsvblockchain.com/docs/build-with-ai/llm-resources.md): Read the BSV blockchain docs as Markdown through llms.txt and a .md copy of every page, and give an AI agent rules that keep it on testnet. ## Guides - [Guides overview](https://bsvblockchain.com/docs/guides.md): Pick the right kind of guide: use cases add one capability, Build your app takes a project to production, Services and infrastructure covers broadcasting and running a node or a service, and Examples are complete apps to copy from. ### Use cases - [Gate an API behind payments](https://bsvblockchain.com/docs/guides/payments.md): Charge for API routes with HTTP 402 Payment Required, using an Express middleware that prices a route and a fetch wrapper that pays from a BRC-100 wallet and repeats the request. - [Authenticate users with their wallet](https://bsvblockchain.com/docs/guides/identity-auth.md): Use the identity key of a BSV blockchain wallet to know which user sends each request to your Express API, with mutual authentication handled by middleware. - [Store data and files](https://bsvblockchain.com/docs/guides/data-storage.md): Put data in a transaction output on the BSV blockchain through the user's wallet and read it back with the TypeScript SDK. - [Send messages between users](https://bsvblockchain.com/docs/guides/messaging.md): Send encrypted messages and payments between users with MessageBox, which holds each message until its recipient reads it. - [Track transactions with overlays](https://bsvblockchain.com/docs/guides/overlays.md): Index your app's transactions in an overlay and look them up by service, instead of scanning the chain. - [Digital product passports on the BSV blockchain](https://bsvblockchain.com/docs/guides/digital-product-passports.md): Learn how a digital product passport maps onto the BSV blockchain, check a test passport offline and read its verification report, then continue in the DPP docs to build one. ### Build your app - [Integrate the BSV blockchain with web frameworks](https://bsvblockchain.com/docs/guides/app-frameworks.md): Add a BSV blockchain wallet button to a Next.js or React app that connects to the user's wallet, sends a payment and calls an Express API that knows which wallet signed the request. - [Request permissions and organize outputs](https://bsvblockchain.com/docs/guides/wallet-aware-apps.md): Group the outputs your app creates with baskets, tags and labels, and know which permission windows BSV Desktop shows the user. - [Let users log in with any wallet](https://bsvblockchain.com/docs/guides/wallet-login.md): Build a login that finds the user's wallet on the computer, waits while it is locked, and pairs a phone wallet such as BSV Browser by QR code with Wallet Relay, following BRC-185. - [Move your app to mainnet](https://bsvblockchain.com/docs/guides/go-to-mainnet.md): Switch BSV Desktop and your server wallet from testnet to Mainnet, check the network from your app, and get real BitcoinSV (BSV) from buybsv.com. ### Services and infrastructure - [Broadcasters, nodes and overlays](https://bsvblockchain.com/docs/guides/services.md): Send transactions with BSV Broadcaster, and find the docs for running a node or a BSV blockchain service yourself. - [Broadcast transactions with BSV Broadcaster](https://bsvblockchain.com/docs/guides/services/broadcasting.md): Send a signed transaction to BSV Broadcaster, pick an endpoint and follow the transaction until it is mined. ### Examples - [Example apps](https://bsvblockchain.com/docs/showcase.md): Working demo apps built on the BSV blockchain, each with its source code, for finding the one closest to what you are building. - [P2P Medical](https://bsvblockchain.com/docs/showcase/p2p-medical.md): A demo where a patient encrypts a medical file in the browser and shares it with a doctor through BSV blockchain wallets, UHRP storage and an audit timeline. - [Time Anchor](https://bsvblockchain.com/docs/showcase/time-anchor.md): A desktop app that records the SHA-256 hash of a file in a transaction on the BSV blockchain, finds it again through an overlay service and can keep an encrypted copy with UHRP. - [Beef Inspector](https://bsvblockchain.com/docs/showcase/beef-inspector.md): Parse a BEEF payload and see its SPV proofs, a tool for debugging. ## Learn ### How the BSV blockchain works #### About the BSV blockchain - [What is the BSV blockchain](https://bsvblockchain.com/docs/learn/what-is-bsv.md): What the BSV blockchain is and what you can build on it. - [How the BSV blockchain works](https://bsvblockchain.com/docs/learn.md): How your app, the user's wallet and shared services work together on the BSV blockchain, and which page explains each concept. - [BSV blockchain glossary](https://bsvblockchain.com/docs/learn/glossary.md): Look up a BSV blockchain term in one line, with a link to the page that explains it. ##### BSV blockchain wiki - [BSV blockchain wiki](https://bsvblockchain.com/docs/learn/wiki.md): Background articles on how blocks, cryptography and transactions work on the BSV blockchain, written for developers. - [Blockchain](https://bsvblockchain.com/docs/learn/wiki/blockchain.md): How a block is built, how blocks link into a chain, and how proof of work, Merkle trees and the coinbase transaction fit together. - [Cryptography](https://bsvblockchain.com/docs/learn/wiki/cryptography.md): The hash functions, keys and signatures that transactions on the BSV blockchain rely on, and what each one does in a transaction. - [Bitcoin transactions](https://bsvblockchain.com/docs/learn/wiki/bitcoin-transactions.md): The fields of a transaction, how an input points to an output, what a transaction ID covers, and the settings nodes apply to the transactions they relay. #### Concepts - [Understand how your transaction worked](https://bsvblockchain.com/docs/concepts/how-your-payment-worked.md): Understand the model behind your first transaction: the app asks and the wallet signs (BRC-100), actions and outputs, UTXOs and the fee. - [How the BSV blockchain stack fits together](https://bsvblockchain.com/docs/concepts/architecture.md): How an app, a wallet and the services behind it work together on the BSV blockchain, and where each package sits from cryptography up to your app. - [BRC-100: Wallet Application Interface](https://bsvblockchain.com/docs/concepts/wallet-model.md): The standard interface between an app and a wallet, where the app asks for an action, the wallet holds the keys and decides how to do it, and any compliant wallet can answer. - [How transactions and fees work](https://bsvblockchain.com/docs/concepts/transactions.md): What a transaction on the BSV blockchain is made of, how its inputs spend earlier outputs, how its fee follows from size and rate, and how it reaches a block. - [How Script works](https://bsvblockchain.com/docs/concepts/script.md): Understand locking and unlocking scripts, how a spend is checked on one stack, and how script templates in @bsv/sdk package them. - [How keys and identity work](https://bsvblockchain.com/docs/concepts/keys-identity.md): Understand private and public keys, how BRC-42 derives a separate key for each counterparty, and how an identity key authenticates a user on the BSV blockchain. - [BEEF (BRC-62)](https://bsvblockchain.com/docs/concepts/spv.md): The binary format that sends a transaction together with the proofs an app needs to verify it without running a full node. - [How overlays work](https://bsvblockchain.com/docs/concepts/overlays.md): Overlays track the transactions of one app or protocol, so the app can look them up later without scanning the chain. - [How BSV blockchain networks differ](https://bsvblockchain.com/docs/concepts/networks.md): Understand Mainnet, testnet and teratestnet, and why the wallet and your code must be on the same network. ### BSV Academy #### All courses - [BSV Academy](https://bsvblockchain.com/docs/learn/academy.md): Take structured courses on Bitcoin and the BSV blockchain. Carried over unchanged from the Hub. #### Bitcoin Whitepaper Series - [Bitcoin whitepaper abstract](https://bsvblockchain.com/docs/learn/academy/bitcoin-whitepaper-series/bitcoin-whitepaper-abstract.md): A lesson from the Bitcoin Whitepaper Series. - [Assessment](https://bsvblockchain.com/docs/learn/academy/bitcoin-whitepaper-series/bitcoin-whitepaper-abstract/assessment-1.md): The lesson's assessment. #### BSV Theory - [Abstract](https://bsvblockchain.com/docs/learn/academy/bsv-theory/abstract.md): A lesson from BSV Theory. - [Cooperation in the network](https://bsvblockchain.com/docs/learn/academy/bsv-theory/abstract/cooperation-in-the-network.md): A lesson from BSV Theory. #### Introduction to Blockchain Technology - [Blockchain applications around the world](https://bsvblockchain.com/docs/learn/academy/introduction-to-blockchain-technology/blockchain-applications-around-the-world.md): A lesson from Introduction to Blockchain Technology. - [Assessment](https://bsvblockchain.com/docs/learn/academy/introduction-to-blockchain-technology/blockchain-applications-around-the-world/assessment-1.md): The lesson's assessment. ## SDKs - [SDKs overview](https://bsvblockchain.com/docs/sdk.md): Choose a BSV blockchain SDK by language, with TypeScript, Go and Python available and Rust in development, then pick the TypeScript package that fits what you are building. ### TypeScript #### @bsv/simple - [Build apps with @bsv/simple](https://bsvblockchain.com/docs/sdk/simple.md): @bsv/simple is a TypeScript helper library on top of @bsv/sdk that gives a browser or server app one wallet object with methods for payments, tokens, data on chain, message box payments, identity and overlays. - [How @bsv/simple is built](https://bsvblockchain.com/docs/sdk/simple/architecture.md): @bsv/simple puts a BRC-100 wallet, the @bsv/sdk classes and a few hosted services behind one wallet object, in the browser and on the server. - [Connect to a browser wallet](https://bsvblockchain.com/docs/sdk/simple/browser-wallet.md): createWallet from @bsv/simple/browser connects a web page to the user's BRC-100 wallet and returns an object with methods for payments, tokens and data. #### TypeScript SDK - [Use the TypeScript SDK](https://bsvblockchain.com/docs/sdk/typescript.md): @bsv/sdk is the TypeScript library for BSV blockchain apps, used to call the user's wallet through WalletClient or to build keys, scripts and transactions directly, in Node, browsers and React. - [Install the SDK in Node or React](https://bsvblockchain.com/docs/sdk/typescript/setup.md): Install @bsv/sdk in a Node (CommonJS or ESM) or React project. - [Connect to a wallet with WalletClient](https://bsvblockchain.com/docs/sdk/typescript/wallet-client.md): WalletClient from @bsv/sdk finds the user's BRC-100 wallet and sends it method calls, from a browser or from Node.js. #### Low-level transactions - [Build transactions by hand](https://bsvblockchain.com/docs/sdk/typescript/low-level.md): Build BSV blockchain transactions, keys and scripts directly with @bsv/sdk, without a wallet, when your code needs full control of each input, output and script. - [Build a transaction from inputs and outputs](https://bsvblockchain.com/docs/sdk/typescript/low-level/transactions.md): Build, sign and broadcast a BSV transaction with @bsv/sdk, with one input spent through a P2PKH script template, a payment output and a change output, on testnet. - [Derive HD keys with BIP32](https://bsvblockchain.com/docs/sdk/typescript/low-level/hd-keys.md): Derive child keys and testnet addresses from a BIP32 extended key or a BIP39 recovery phrase with the HD class of @bsv/sdk. - [Write a custom script template](https://bsvblockchain.com/docs/sdk/typescript/low-level/script-templates.md): A script template in @bsv/sdk packages a locking script and the unlocking script that spends it, so a custom spending condition plugs into Transaction like P2PKH. #### More TypeScript packages - [Find more TypeScript packages](https://bsvblockchain.com/docs/sdk/packages.md): Find the @bsv/* package for messaging, authentication, payments, overlays and more, with what each one does and its status, on top of @bsv/sdk. - [Send messages with @bsv/message-box-client](https://bsvblockchain.com/docs/sdk/packages/message-box-client.md): @bsv/message-box-client sends and receives encrypted messages and payments between identities on the BSV blockchain through a MessageBox host. - [Charge for HTTP requests with @bsv/402-pay](https://bsvblockchain.com/docs/sdk/packages/402-pay.md): @bsv/402-pay charges for HTTP routes with BSV micropayments. An Express middleware answers 402 with a price, and a fetch wrapper pays from a wallet and repeats the request. - [Run an overlay with @bsv/overlay-express](https://bsvblockchain.com/docs/sdk/packages/overlay-express.md): @bsv/overlay-express runs an overlay service on an Express server, with SQL and MongoDB storage, health checks and an admin API. ### Other languages - [Use the Go SDK](https://bsvblockchain.com/docs/sdk/go.md): go-sdk is the Go library for BSV blockchain apps: keys, scripts, transactions, proofs, a wallet interface and overlay services, with its docs and examples in the Go repositories. - [Use the Python SDK](https://bsvblockchain.com/docs/sdk/python.md): bsv-sdk is the Python library for BSV blockchain apps: keys, scripts, transactions, proofs, broadcasting and wallets, with its docs and examples in the Python repositories. ### SDK reference - [SDK default values](https://bsvblockchain.com/docs/sdk/defaults.md): The values the BSV blockchain TypeScript packages use when you do not set them: the transaction fee rate, the input sequence number, the network, the storage server and the broadcasters. - [Supported runtimes](https://bsvblockchain.com/docs/sdk/runtimes.md): What @bsv/sdk needs from a JavaScript runtime, the builds it ships for Node.js, bundlers and script tags, and the errors it raises when the runtime lacks one of them. #### SDK API reference - [SDK API reference](https://bsvblockchain.com/docs/sdk/api.md): The SDK API reference lists the methods of the two @bsv/simple wallet objects, BrowserWallet and ServerWallet, with their options, defaults and errors. - [BrowserWallet class](https://bsvblockchain.com/docs/sdk/api/simple/browser-wallet.md): BrowserWallet is the @bsv/simple wallet object for web apps, which connects to the user's BRC-100 wallet so the wallet holds the keys and signs each transaction. - [ServerWallet class](https://bsvblockchain.com/docs/sdk/api/simple/server-wallet.md): ServerWallet is the @bsv/simple wallet object for Node.js servers, which signs with a private key the server holds and keeps its records on a remote storage server. ## Reference ### Getting started - [Reference overview](https://bsvblockchain.com/docs/reference.md): The BSV blockchain reference: the BRC-100 Wallet API, the HTTP APIs of BSV blockchain services, the endpoints of each network, wallet error codes and the Paymail standard. - [Network endpoints](https://bsvblockchain.com/docs/reference/networks.md): The explorer, faucet, broadcast endpoints, wallet storage and address format of every BSV blockchain network that @bsv/sdk and @bsv/wallet-toolbox support. - [Error codes](https://bsvblockchain.com/docs/reference/errors.md): The errors a BSV blockchain wallet returns through the BRC-100 interface, what each one means and what to check, from @bsv/sdk and @bsv/wallet-toolbox. - [Script opcodes](https://bsvblockchain.com/docs/reference/script-opcodes.md): Look up any Script opcode by name: its hex byte value and what it does, grouped by what the opcode works on. ### Wallet API (BRC-100) #### Actions - [createAction](https://bsvblockchain.com/docs/reference/wallet-api/actions/post-createaction.md): Creates a new Bitcoin transaction (POST /createAction) - [signAction](https://bsvblockchain.com/docs/reference/wallet-api/actions/post-signaction.md): Signs a transaction previously created using `createAction` (POST /signAction) - [abortAction](https://bsvblockchain.com/docs/reference/wallet-api/actions/post-abortaction.md): Aborts a transaction that is in progress (POST /abortAction) - [listActions](https://bsvblockchain.com/docs/reference/wallet-api/actions/post-listactions.md): Lists all transactions matching the specified labels (POST /listActions) - [internalizeAction](https://bsvblockchain.com/docs/reference/wallet-api/actions/post-internalizeaction.md): Submits a transaction to be internalized (POST /internalizeAction) #### Outputs - [listOutputs](https://bsvblockchain.com/docs/reference/wallet-api/outputs/post-listoutputs.md): Lists the spendable outputs kept within a specific basket (POST /listOutputs) - [relinquishOutput](https://bsvblockchain.com/docs/reference/wallet-api/outputs/post-relinquishoutput.md): Relinquish an output out of a basket (POST /relinquishOutput) #### Keys and cryptography - [getPublicKey](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-getpublickey.md): Retrieves the public key (POST /getPublicKey) - [revealCounterpartyKeyLinkage](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-revealcounterpartykeylinkage.md): Reveals counterparty key linkage (POST /revealCounterpartyKeyLinkage) - [revealSpecificKeyLinkage](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-revealspecifickeylinkage.md): Reveals specific key linkage (POST /revealSpecificKeyLinkage) - [encrypt](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-encrypt.md): Encrypts data (POST /encrypt) - [decrypt](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-decrypt.md): Decrypts data (POST /decrypt) - [createHmac](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-createhmac.md): Creates HMAC (POST /createHmac) - [verifyHmac](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-verifyhmac.md): Verifies HMAC (POST /verifyHmac) - [createSignature](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-createsignature.md): Creates a signature (POST /createSignature) - [verifySignature](https://bsvblockchain.com/docs/reference/wallet-api/keys-and-cryptography/post-verifysignature.md): Verifies a signature (POST /verifySignature) #### Certificates - [acquireCertificate](https://bsvblockchain.com/docs/reference/wallet-api/certificates/post-acquirecertificate.md): Acquires a certificate (POST /acquireCertificate) - [listCertificates](https://bsvblockchain.com/docs/reference/wallet-api/certificates/post-listcertificates.md): Lists certificates (POST /listCertificates) - [proveCertificate](https://bsvblockchain.com/docs/reference/wallet-api/certificates/post-provecertificate.md): Proves a certificate (POST /proveCertificate) - [relinquishCertificate](https://bsvblockchain.com/docs/reference/wallet-api/certificates/post-relinquishcertificate.md): Relinquishes a certificate (POST /relinquishCertificate) #### Identity discovery - [discoverByIdentityKey](https://bsvblockchain.com/docs/reference/wallet-api/identity-discovery/post-discoverbyidentitykey.md): Discovers certificates by identity key (POST /discoverByIdentityKey) - [discoverByAttributes](https://bsvblockchain.com/docs/reference/wallet-api/identity-discovery/post-discoverbyattributes.md): Discovers certificates by attributes (POST /discoverByAttributes) #### Authentication - [isAuthenticated](https://bsvblockchain.com/docs/reference/wallet-api/authentication/post-isauthenticated.md): Checks if the user is authenticated (POST /isAuthenticated) - [waitForAuthentication](https://bsvblockchain.com/docs/reference/wallet-api/authentication/post-waitforauthentication.md): Waits for user authentication (POST /waitForAuthentication) #### Chain and wallet info - [getHeight](https://bsvblockchain.com/docs/reference/wallet-api/chain-and-wallet-info/post-getheight.md): Retrieves the current blockchain height (POST /getHeight) - [getHeaderForHeight](https://bsvblockchain.com/docs/reference/wallet-api/chain-and-wallet-info/post-getheaderforheight.md): Retrieves the block header for a specific height (POST /getHeaderForHeight) - [getNetwork](https://bsvblockchain.com/docs/reference/wallet-api/chain-and-wallet-info/post-getnetwork.md): Retrieves the current network (POST /getNetwork) - [getVersion](https://bsvblockchain.com/docs/reference/wallet-api/chain-and-wallet-info/post-getversion.md): Retrieves the current version (POST /getVersion) ### Service APIs #### Service APIs overview - [Service APIs overview](https://bsvblockchain.com/docs/reference/http-apis.md): Look up the HTTP and WebSocket APIs of BSV blockchain services: broadcasting, overlays, MessageBox, Merkle proofs, UHRP storage, wallet storage and HTTP 402 payments. - [AuthSocket WebSocket protocol](https://bsvblockchain.com/docs/reference/http-apis/authsocket.md): Look up the frames and events of AuthSocket, the Socket.IO protocol in which a client and a server prove their identity keys with BRC-103 and sign every application event. - [BRC-103 mutual authentication](https://bsvblockchain.com/docs/reference/http-apis/brc-103-mutual-auth.md): Look up the messages of the BRC-103 handshake and of the signed requests and responses that follow it, as carried over HTTP (BRC-104) and Socket.IO. #### ARC broadcast ##### transactions - [Get the status of a transaction by txid](https://bsvblockchain.com/docs/reference/arc/transactions/get-v1-tx.md): Retrieves the current network status of a transaction. Not directly (GET /v1/tx) - [Submit a single transaction](https://bsvblockchain.com/docs/reference/arc/transactions/post-v1-tx.md): Submits a single raw transaction to the ARC network. The body must be a (POST /v1/tx) - [Get the status of a transaction by path parameter](https://bsvblockchain.com/docs/reference/arc/transactions/get-v1-tx-txid.md): Retrieves the current network status of a transaction using the txid as a (GET /v1/tx/{txid}) - [Submit a batch of transactions](https://bsvblockchain.com/docs/reference/arc/transactions/post-v1-txs.md): Submits an array of raw transactions in a single HTTP request. (POST /v1/txs) ##### callbacks - [ARC Merkle proof callback (inbound to overlay node)](https://bsvblockchain.com/docs/reference/arc/callbacks/post-arc-ingest.md): ARC POSTs this to the URL specified in `X-CallbackUrl` when a submitted (POST /arc-ingest) #### Overlay ##### data-plane - [Submit a tagged BEEF transaction](https://bsvblockchain.com/docs/reference/overlay/data-plane/post-submit.md): Accepts a raw BEEF (BRC-62) binary body. The request must include an (POST /submit) - [Query a lookup service](https://bsvblockchain.com/docs/reference/overlay/data-plane/post-lookup.md): Sends a lookup request to the specified lookup service. The request body (POST /lookup) - [ARC Merkle proof callback](https://bsvblockchain.com/docs/reference/overlay/data-plane/post-arc-ingest.md): Receives Merkle proof notifications from ARC after a transaction has been (POST /arc-ingest) ##### discovery - [List hosted topic managers](https://bsvblockchain.com/docs/reference/overlay/discovery/get-listtopicmanagers.md): Returns the names and metadata of all Topic Managers configured on this (GET /listTopicManagers) - [List hosted lookup service providers](https://bsvblockchain.com/docs/reference/overlay/discovery/get-listlookupserviceproviders.md): Returns the names and metadata of all Lookup Services configured on this (GET /listLookupServiceProviders) - [Get Markdown documentation for a topic manager](https://bsvblockchain.com/docs/reference/overlay/discovery/get-getdocumentationfortopicmanager.md): Returns the human-readable Markdown documentation string provided by the (GET /getDocumentationForTopicManager) - [Get Markdown documentation for a lookup service provider](https://bsvblockchain.com/docs/reference/overlay/discovery/get-getdocumentationforlookupserviceprovider.md): Returns the human-readable Markdown documentation string provided by the (GET /getDocumentationForLookupServiceProvider) ##### gasp-sync - [GASP β€” provide a foreign sync response](https://bsvblockchain.com/docs/reference/overlay/gasp-sync/post-requestsyncresponse.md): Used by a peer overlay node to request a sync response. The engine's (POST /requestSyncResponse) - [GASP β€” provide a foreign GASP node](https://bsvblockchain.com/docs/reference/overlay/gasp-sync/post-requestforeigngaspnode.md): Used by a peer overlay node to request a specific GASP node (graph vertex) (POST /requestForeignGASPNode) ##### health - [Full health report (live + ready checks)](https://bsvblockchain.com/docs/reference/overlay/health/get-health.md): GET /health - [Liveness probe β€” is the process alive?](https://bsvblockchain.com/docs/reference/overlay/health/get-health-live.md): GET /health/live - [Readiness probe β€” is the service ready to accept traffic?](https://bsvblockchain.com/docs/reference/overlay/health/get-health-ready.md): GET /health/ready ##### admin - [Public admin config (no auth required)](https://bsvblockchain.com/docs/reference/overlay/admin/get-admin-config.md): Returns the admin identity key (if configured) and the node name. (GET /admin/config) - [Server statistics overview](https://bsvblockchain.com/docs/reference/overlay/admin/get-admin-stats.md): GET /admin/stats - [List SHIP records](https://bsvblockchain.com/docs/reference/overlay/admin/get-admin-ship-records.md): GET /admin/ship-records - [List SLAP records](https://bsvblockchain.com/docs/reference/overlay/admin/get-admin-slap-records.md): GET /admin/slap-records - [List all bans](https://bsvblockchain.com/docs/reference/overlay/admin/get-admin-bans.md): GET /admin/bans - [Ban a domain or outpoint](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-ban.md): POST /admin/ban - [Remove a ban](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-unban.md): POST /admin/unban - [Evict an outpoint from lookup services](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-evictoutpoint.md): POST /admin/evictOutpoint - [Remove a token and optionally ban the domain](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-remove-token.md): POST /admin/remove-token - [Check the health of a specific URL](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-health-check.md): POST /admin/health-check - [Run the janitor service](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-janitor.md): Runs the janitor service, which checks SHIP/SLAP hosts for availability, (POST /admin/janitor) - [Manually sync SHIP/SLAP advertisements](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-syncadvertisements.md): POST /admin/syncAdvertisements - [Manually start GASP sync](https://bsvblockchain.com/docs/reference/overlay/admin/post-admin-startgaspsync.md): POST /admin/startGASPSync #### MessageBox ##### Meta - [Report process liveness](https://bsvblockchain.com/docs/reference/message-box/meta/get-health.md): GET /health - [Report database readiness](https://bsvblockchain.com/docs/reference/message-box/meta/get-ready.md): GET /ready - [Swagger UI (served by swagger-ui-express)](https://bsvblockchain.com/docs/reference/message-box/meta/get-docs.md): Human-readable API documentation. Not part of the machine contract. (GET /docs) - [Raw OpenAPI spec as JSON](https://bsvblockchain.com/docs/reference/message-box/meta/get-openapi-json.md): The swagger-jsdoc-generated spec at runtime. (GET /openapi.json) ##### Message - [Send a message to one or more recipients' message boxes](https://bsvblockchain.com/docs/reference/message-box/message/post-sendmessage.md): Inserts a message into each recipient's named message box. If the box (POST /sendMessage) - [Retrieve messages from a named message box](https://bsvblockchain.com/docs/reference/message-box/message/post-listmessages.md): Returns one deterministic, bounded page of stored messages belonging (POST /listMessages) - [Acknowledge receipt of one or more messages](https://bsvblockchain.com/docs/reference/message-box/message/post-acknowledgemessage.md): Permanently deletes the specified messages from the database for the (POST /acknowledgeMessage) ##### Device - [Register a device for FCM push notifications](https://bsvblockchain.com/docs/reference/message-box/device/post-registerdevice.md): Stores or refreshes an FCM token for the authenticated identity. A (POST /registerDevice) - [List registered devices for the authenticated identity](https://bsvblockchain.com/docs/reference/message-box/device/get-devices.md): Returns one bounded page of device registrations for the authenticated user, sorted by (GET /devices) ##### Permissions - [Set a message permission for a sender or as a box-wide default](https://bsvblockchain.com/docs/reference/message-box/permissions/post-permissions-set.md): Sets the `recipientFee` for messages arriving in a named message box. (POST /permissions/set) - [Get the message permission for a sender/box combination](https://bsvblockchain.com/docs/reference/message-box/permissions/get-permissions-get.md): Retrieves the permission record for a specific sender + message box pair (GET /permissions/get) - [List message permissions for the authenticated user](https://bsvblockchain.com/docs/reference/message-box/permissions/get-permissions-list.md): Returns one bounded page of permission records owned by the (GET /permissions/list) - [Get message delivery quote(s)](https://bsvblockchain.com/docs/reference/message-box/permissions/get-permissions-quote.md): Returns pricing information for sending a message to one or more (GET /permissions/quote) #### Merkle service ##### Watch - [Register a transaction for merkle proof delivery.](https://bsvblockchain.com/docs/reference/merkle-service/watch/post-watch.md): Registers a transaction ID (`txid`) for merkle proof monitoring. (POST /watch) ##### Health - [Service health check.](https://bsvblockchain.com/docs/reference/merkle-service/health/get-health.md): Returns the current health status of the Merkle Service and its (GET /health) #### UHRP storage ##### Upload - [Initiate a file upload (inferred from BRC-26 status note)](https://bsvblockchain.com/docs/reference/uhrp/upload/post-upload.md): Request an upload slot for a file. The server responds with a (POST /upload) ##### Resolution - [Find the download URL(s) for a UHRP URL (inferred)](https://bsvblockchain.com/docs/reference/uhrp/resolution/get-find.md): Queries this server's knowledge of advertisement tokens for the given (GET /find) ##### Management - [List all files currently advertised by this host (inferred)](https://bsvblockchain.com/docs/reference/uhrp/management/get-list.md): Returns a paginated list of UHRP advertisement records that this (GET /list) - [Renew a UHRP advertisement token (inferred)](https://bsvblockchain.com/docs/reference/uhrp/management/post-renew.md): Extends the expiry of an existing advertisement UTXO by spending the (POST /renew) #### Wallet storage ##### Settings - [Read storage identity and configuration settings.](https://bsvblockchain.com/docs/reference/wallet-storage/settings/get-settings.md): Returns the single `TableSettings` row for this storage instance, (GET /settings) - [Run database migrations.](https://bsvblockchain.com/docs/reference/wallet-storage/settings/post-migrate.md): Applies pending schema migrations. Returns the migrated storage name (POST /migrate) ##### Actions - [Create a new wallet action (unsigned transaction).](https://bsvblockchain.com/docs/reference/wallet-storage/actions/post-actions.md): Corresponds to `StorageProvider.createAction(auth, args)`. (POST /actions) - [Process a signed action (broadcast + store).](https://bsvblockchain.com/docs/reference/wallet-storage/actions/post-actions-process.md): Corresponds to `StorageProvider.processAction(auth, args)`. (POST /actions/process) - [Abort an unsigned / in-process action.](https://bsvblockchain.com/docs/reference/wallet-storage/actions/post-actions-abort.md): Corresponds to `StorageProvider.abortAction(auth, args)`. (POST /actions/abort) - [Internalize an external transaction (receive payment).](https://bsvblockchain.com/docs/reference/wallet-storage/actions/post-actions-internalize.md): Corresponds to `StorageProvider.internalizeAction(auth, args)`. (POST /actions/internalize) ##### List - [List wallet actions (transactions).](https://bsvblockchain.com/docs/reference/wallet-storage/list/post-list-actions.md): POST /list/actions - [List wallet outputs (UTXOs).](https://bsvblockchain.com/docs/reference/wallet-storage/list/post-list-outputs.md): POST /list/outputs - [List identity certificates.](https://bsvblockchain.com/docs/reference/wallet-storage/list/post-list-certificates.md): POST /list/certificates ##### Sync - [Export a chunk of storage records for sync.](https://bsvblockchain.com/docs/reference/wallet-storage/sync/post-sync-chunk.md): Corresponds to `WalletStorageSync.getSyncChunk(args)`. (POST /sync/chunk) - [Apply a sync chunk from another storage provider.](https://bsvblockchain.com/docs/reference/wallet-storage/sync/post-sync-process.md): Corresponds to `WalletStorageSync.processSyncChunk(args, chunk)`. (POST /sync/process) - [Find or create a sync state record for a foreign storage provider.](https://bsvblockchain.com/docs/reference/wallet-storage/sync/post-sync-state.md): POST /sync/state - [Update the active storage for the authenticated user.](https://bsvblockchain.com/docs/reference/wallet-storage/sync/post-sync-active.md): POST /sync/active ##### Certificates - [Insert an identity certificate.](https://bsvblockchain.com/docs/reference/wallet-storage/certificates/post-certificates.md): POST /certificates - [Soft-delete (relinquish) a certificate.](https://bsvblockchain.com/docs/reference/wallet-storage/certificates/post-certificates-relinquish.md): POST /certificates/relinquish ##### Outputs - [Remove an output from its basket (relinquish).](https://bsvblockchain.com/docs/reference/wallet-storage/outputs/post-outputs-relinquish.md): POST /outputs/relinquish #### BRC-121 payments ##### Protocol - [Fetch a BRC-121-protected HTTP resource.](https://bsvblockchain.com/docs/reference/brc-121/protocol/get-resourcepath.md): When called without payment headers the server returns 402. (GET /{resourcePath}) ### Standards - [Standards overview](https://bsvblockchain.com/docs/standards.md): Find the standards BSV blockchain apps follow (BRCs, BRC-100, Paymail, the Bitcoin protocol and the Network Access Rules) and the site that holds each specification. - [BRC specifications index](https://bsvblockchain.com/docs/standards/brc-index.md): Look up any BRC, a numbered BSV blockchain specification, by number or title, with a link to its text on bsv.brc.dev. - [BRC-100 wallet standard](https://bsvblockchain.com/docs/standards/brc-100.md): What BRC-100 defines between an app and a wallet, the methods, limits, names, errors and binary format, and what it leaves to each wallet, with links to the specification. #### Paymail specification - [Look up a user's identity key with Paymail](https://bsvblockchain.com/docs/standards/paymail.md): Use a Paymail handle to discover a user's services and resolve the handle into their identity key. - [Resolve a Paymail address](https://bsvblockchain.com/docs/standards/paymail/basic-address-resolution.md): Resolve a Paymail handle to an output script. - [Discover Paymail capabilities](https://bsvblockchain.com/docs/standards/paymail/capability-discovery.md): Find which Paymail capabilities a host supports. - [BRFC specification process](https://bsvblockchain.com/docs/standards/paymail/brfc-specifications.md): Look up the BRFC specification process and IDs. ## Wallets - [Wallets overview](https://bsvblockchain.com/docs/wallets.md): Pick a wallet to use, BSV Desktop on a computer or BSV Browser on a phone, or start building your own BRC-100 wallet. ### Use a wallet - [BSV Desktop](https://bsvblockchain.com/docs/wallets/bsv-desktop.md): BSV Desktop is the BRC-100 wallet for macOS, Windows and Linux that keeps your keys on your device and signs what your apps request. - [BSV Browser](https://bsvblockchain.com/docs/wallets/bsv-browser.md): BSV Browser is BSV Association's mobile wallet for iOS and Android, a web browser with a self-custodial wallet inside. - [Back up and recover a wallet](https://bsvblockchain.com/docs/wallets/backup-recovery.md): A BSV Desktop backup keeps the keys in a recovery phrase or backup shares and the balance and history in an encrypted wallet data file. ### Build a wallet - [Build a wallet](https://bsvblockchain.com/docs/wallet-dev.md): Follow the path for building a BRC-100 wallet: the interface, wallet-toolbox, storage, permissions, conformance tests and backend services. - [Add permission modules](https://bsvblockchain.com/docs/wallet-dev/permissions.md): Add permission modules that control what apps may ask your wallet to do. - [Run a wallet backend](https://bsvblockchain.com/docs/wallet-dev/infrastructure.md): Run the two backend services a BRC-100 wallet can use: Wallet Infra for remote wallet storage and the Wallet Authentication Backend (WAB) for phone sign-in and recovery. #### Use wallet-toolbox - [Build a wallet with wallet-toolbox](https://bsvblockchain.com/docs/wallet-dev/wallet-toolbox.md): Set up a BRC-100 wallet with the Setup helpers of @bsv/wallet-toolbox, run its Monitor and choose where it stores its records. - [How the toolbox tracks UTXOs](https://bsvblockchain.com/docs/wallet-dev/wallet-toolbox/utxo-lifecycle.md): How @bsv/wallet-toolbox records each output from the moment createAction plans it until a later transaction spends it, and what the Monitor settles in the background. - [Plug in your own storage](https://bsvblockchain.com/docs/wallet-dev/wallet-toolbox/storage-adapter.md): WalletStorageManager in @bsv/wallet-toolbox keeps a wallet's records in an active store and copies them to backup stores: a database you open, a storage server you run, or a provider you write. #### Test conformance - [Test BRC-100 conformance](https://bsvblockchain.com/docs/wallet-dev/conformance.md): Run the ts-stack test vectors against a BRC-100 wallet and back a conformance claim with a pass for every required vector. - [Browse the test vectors](https://bsvblockchain.com/docs/wallet-dev/conformance/vector-catalog.md): The BRC-100 test vectors in ts-stack: 955 vectors in 28 files, one file per wallet method, and how many of each a wallet must pass. - [Run the vectors in TypeScript](https://bsvblockchain.com/docs/wallet-dev/conformance/typescript-runner.md): Run the BRC-100 test vectors with the Jest runner in ts-stack, first against the reference wallet, then against a wallet of your choice. ## Changelog - [Changelog overview](https://bsvblockchain.com/docs/changelog.md): See what changed across BSV blockchain products, with a card per product and a legend of change types. - [What's new](https://bsvblockchain.com/docs/changelog/whats-new.md): Read the curated highlights across all products. ### Products - [@bsv/simple](https://bsvblockchain.com/docs/changelog/simple.md): See every @bsv/simple release. - [TypeScript SDK (@bsv/sdk)](https://bsvblockchain.com/docs/changelog/sdk.md): See every @bsv/sdk release, generated from its CHANGELOG.md. - [Wallet toolbox](https://bsvblockchain.com/docs/changelog/wallet-toolbox.md): See every wallet-toolbox release, generated from its CHANGELOG.md. - [Overlays](https://bsvblockchain.com/docs/changelog/overlays.md): See every release of the overlay packages. - [Messaging](https://bsvblockchain.com/docs/changelog/messaging.md): See every release of MessageBox client and Paymail. - [Payments middleware (402-pay)](https://bsvblockchain.com/docs/changelog/payments-middleware.md): See every release of the 402-pay payments middleware. - [Wallet infrastructure (WAB)](https://bsvblockchain.com/docs/changelog/wallet-infrastructure.md): See every release of the wallet infrastructure (WAB). - [Other packages](https://bsvblockchain.com/docs/changelog/other-packages.md): See releases of the remaining packages (templates, p2p). ## Node Software ### Nodes #### Run SV Node - [Run SV Node](https://bsvblockchain.com/docs/nodes/sv-node.md): What SV Node is, whether you need your own node, and how to install, configure and call it. - [Install SV Node](https://bsvblockchain.com/docs/nodes/sv-node/installation.md): Get the SV Node software, bitcoind, from the official Docker image or by building the release source. - [Configure SV Node](https://bsvblockchain.com/docs/nodes/sv-node/configuration.md): Set the required parameters and the main options of SV Node in bitcoin.conf or on the command line. - [SV Node RPC methods](https://bsvblockchain.com/docs/nodes/sv-node/rpc-methods.md): Look up the JSON-RPC methods of SV Node 1.2.3 by group, and how to call them. #### Run Teranode - [What is Teranode](https://bsvblockchain.com/docs/nodes/teranode.md): Teranode is horizontally scalable node software for the BSV blockchain, built as separate services that can run on one host or across several. ##### How-to guides - [Monitoring Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-monitoring.md): This guide covers the dashboards Teranode ships out of the box, the metrics that distinguish a healthy node from a degraded one, and how to get started with alerting. ###### Installation - [Install Teranode with Docker](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-installation.md): The supported Docker path for a single-host Teranode deployment is the teranode-quickstart repository. - [How to Install Teranode with Kubernetes Helm](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-installation.md): This guide provides instructions for deploying Teranode in a Kubernetes environment. ###### Configuration - [Configure Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-configure-the-node.md): Docker deployments are configured through the teranode-quickstart repository. Run ./setup.sh for the initial configuration, then edit .env directly for later changes. - [Configuring Kubernetes Operator Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-configure-the-node.md): The Teranode settings can be configured in the operator ConfigMap. You can refer to the notes on the installation and ConfigMap setup here. - [How to Expose the P2P Service Publicly (Kubernetes)](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-expose-p2p.md): Teranode's P2P layer (libp2p) needs inbound TCP connections on the P2P port (9905 in the shipped configuration) to accept direct peer connections. libp2p binds p2pport on all interfaces; the port peers actually dial... - [Aerospike - Configuration Considerations](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-aerospike-tuning.md): Teranode's scaled-out configuration (1m tps design target) uses Aerospike. - [How to Interact with the Asset Server](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-interact-with-asset-server.md): There are 2 primary ways to interact with the node, using the RPC Server, and using the Asset Server. This document will focus on the Asset Server. - [How to Manage Teranode States](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-interact-with-fsm.md): This guide explains how to change and monitor Teranode's state. Fresh production deployments (operator and docker.m settings contexts) start in IDLE, giving an operator a safe inspection window. - [How to Interact with the RPC Server](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-interact-with-rpc-server.md): There are 2 primary ways to interact with the node, using the RPC Server, and using the Asset Server. This document will focus on the RPC Server. ###### Start/Stop - [Start and Stop Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-stop-start-docker-teranode.md): Use the scripts in teranode-quickstart instead of invoking Docker Compose directly. The scripts load .env, use the right Compose profiles, handle FSM transitions, and keep common commands consistent. - [How to Start and Stop Teranode in Kubernetes](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-stop-start-kubernetes-teranode.md): This guide provides instructions for starting and stopping Teranode in a Kubernetes environment using the Teranode Operator and associated configurations. ###### Updating Teranode - [Update Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-updating-teranode.md): Docker updates are managed from the teranode-quickstart repository. Quickstart keeps the local Teranode image tag in .env as TERANODEVERSION. - [How to Update Teranode with Kubernetes Helm](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-updating-teranode.md): This guide provides instructions for updating Teranode in a Kubernetes environment using Helm. ###### Security Best Practices - [Docker Security Best Practices](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-security-best-practices.md): The quickstart deployment is designed to keep most services local by default. - [Security Best Practices](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-security-best-practices.md): Remember, the exact firewall configuration will depend on your specific network setup, security requirements, and how you intend to operate your Teranode. ###### Troubleshooting - [Troubleshoot Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-troubleshooting.md): Use the quickstart scripts first. They keep checks consistent with the Docker Compose files and .env used by the deployment. - [How to Troubleshoot Teranode (Kubernetes Operator)](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-troubleshooting.md): This command lists all pods in the current namespace, showing their status and readiness. ###### Reset Teranode - [Reset Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-reset-teranode.md): Use quickstart's clean.sh script to remove Docker deployment data. Resetting is destructive and should only be done when you need to resync, reseed, switch networks, or recover from bad local state. - [How to Reset Teranode (Kubernetes)](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-reset-teranode.md): If you need to sync Teranode from scratch, restore from a backup, or clean up after testing, you'll need to reset the blockchain data. ###### Sync the Node - [Sync Docker Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/docker/miners-how-to-sync-the-node.md): Docker deployments sync through the teranode-quickstart workflow. You can either let Teranode sync from the network or seed it from a compatible UTXO snapshot before startup. - [Syncing the Blockchain (Kubernetes)](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/kubernetes/miners-how-to-sync-the-node.md): This guide covers the different methods available for synchronizing a Teranode instance with the BSV Blockchain using Kubernetes. ###### Additional - [How to Back Up and Restore Teranode Data](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-backup.md): You must test your restore procedure on your own infrastructure. A backup that nobody has restored from does not prove that recovery works. - [How to Set Up CPU Mining with Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-cpu-miner.md): This guide provides instructions for setting up CPU mining with Teranode using the BSV CPU miner. CPU mining is primarily intended for testing purposes and small-scale mining operations. - [Teranode CLI Documentation](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-teranode-cli.md): The teranode-cli is a command-line interface tool for interacting with Teranode services. It provides various commands for maintenance, debugging, and operational tasks. - [Managing Disk Space - Teranode](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-managing-disk-space.md): Managing Disk Space - Teranode, from the Teranode documentation. - [How to Use Listen Mode for Mining Operations](https://bsvblockchain.com/docs/nodes/teranode/howto/miners/miners-how-to-use-listen-mode.md): Listen Mode is a special operational mode for Teranode that allows nodes to receive blockchain data without broadcasting or propagating information to the network. ##### Key topics - [Teranode Introduction](https://bsvblockchain.com/docs/nodes/teranode/topics/teranode-intro.md): The Bitcoin (BTC) scalability issue refers to the challenge faced by the original Bitcoin network in processing a high volume of transactions efficiently. - [Teranode Overall System Design](https://bsvblockchain.com/docs/nodes/teranode/topics/architecture/teranode-overall-system-design.md): In the early stages of Bitcoin's development, a block size limit of 1 megabyte per block was introduced as a temporary measure. - [Teranode - Architecture Brief](https://bsvblockchain.com/docs/nodes/teranode/topics/architecture/teranode-architecture-brief.md): This is a condensed version of the Teranode architecture documentation. - [Teranode Microservices Overview](https://bsvblockchain.com/docs/nodes/teranode/topics/architecture/teranode-microservices-overview.md): Teranode is designed as a collection of microservices that work together to provide a horizontally scalable and highly efficient blockchain network. - [Transaction Lifecycle in Teranode](https://bsvblockchain.com/docs/nodes/teranode/topics/transaction-lifecycle.md): Understanding how transactions flow through Teranode is fundamental to comprehending the system's architecture and its approach to achieving massive scalability. - [πŸ—‚οΈοΈ State Management in Teranode](https://bsvblockchain.com/docs/nodes/teranode/topics/architecture/state-management.md): A Finite State Machine is a model used in computer science that describes a system which can be in one of a finite number of states at any given time. - [State Machine](https://bsvblockchain.com/docs/nodes/teranode/state-machine-diagram.md): The mermaid diagram outlined below represents the various states and events that dictate the functionality of the node. - [Understanding Double Spend Handling and Conflict Resolution in Teranode](https://bsvblockchain.com/docs/nodes/teranode/topics/architecture/understanding-double-spends.md): A double spend occurs when someone attempts to spend the same Bitcoin UTXO (Unspent Transaction Output) more than once. - [πŸ”§ Technology Stack](https://bsvblockchain.com/docs/nodes/teranode/topics/technology-stack.md): Teranode is written in Go, leveraging its efficiency and simplicity to build scalable, concurrent microservices. - [Teranode Dashboard](https://bsvblockchain.com/docs/nodes/teranode/topics/dashboard.md): The Teranode Dashboard is a web-based user interface for monitoring and managing Teranode nodes. - [TUI Tools](https://bsvblockchain.com/docs/nodes/teranode/topics/tui-tools.md): Both tools run in an alternate screen buffer and refresh automatically, providing a lightweight alternative to the web dashboard that requires no browser or additional dependencies. ###### Features - [Two-Phase Transaction Commit Process](https://bsvblockchain.com/docs/nodes/teranode/topics/features/two-phase-commit.md): The Two-Phase Transaction Commit process is a mechanism implemented in Teranode to ensure atomicity and data consistency during transaction processing across the system's microservice architecture. - [Peer Registry and Reputation System](https://bsvblockchain.com/docs/nodes/teranode/topics/features/peer-registry-reputation.md): The Peer Registry and Reputation System is a comprehensive peer management framework introduced in Teranode to track, evaluate, and select the most reliable peers for network operations. - [UTXO Lock Record Pattern for Multi-Record Transactions](https://bsvblockchain.com/docs/nodes/teranode/topics/features/utxo-lock-records.md): The Lock Record Pattern is a distributed consistency mechanism used by Teranode's UTXO store to safely handle transactions with more outputs than utxostoreutxoBatchSize (default 128). ###### Core Services - [🚨 Alert Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/alert.md): The Teranode Alert Service reintroduces the alert system functionality that was removed from Bitcoin in 2016. - [πŸ—‚οΈ Asset Server](https://bsvblockchain.com/docs/nodes/teranode/topics/services/asset-server.md): The server being externally accessible implies that it is designed to communicate with other nodes and external clients across the network, to share blockchain data or synchronize states. - [πŸ“¦ Block Assembly Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/block-assembly.md): The Block Assembly Service is responsible for assembling new blocks and adding them to the blockchain. - [πŸ” Block Validation Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/block-validation.md): The Legacy Service communicates with the Block Validation over the gRPC protocol. - [🌐 Blockchain Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/blockchain.md): This service implements a local BSV Blockchain service, maintaining the blockchain as understood by the node. - [🌐 Propagation Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/propagation.md): The Propagation Service is designed to handle the propagation of transactions across a peer-to-peer Teranode network. - [πŸ” Subtree Validation Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/subtree-validation.md): Adds metadata to the subtree, to facilitate faster block validation at a later stage (by the Block Validation Service). - [πŸ” TX Validator](https://bsvblockchain.com/docs/nodes/teranode/topics/services/validator.md): The performance difference between these approaches can be significant, as the local validator approach eliminates network overhead between services. ###### Overlay Services - [πŸ” Block Persister Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/block-persister.md): The Block Persister service functions as an overlay microservice, designed to post-process subtrees after their integration into blocks and persisting them to a separate storage. - [🌐 P2P Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/p2p.md): The p2p package implements a peer-to-peer (P2P) server using libp2p (github.com/libp2p/go-libp2p, https://libp2p.io), a modular network stack that allows for direct peer-to-peer communication. - [P2P NAT Traversal and Address Filtering](https://bsvblockchain.com/docs/nodes/teranode/p2p-nat-traversal.md): ℹ️ With the current go-p2p-message-bus this setting has no effect on what is announced: when p2padvertiseaddresses is empty, libp2p advertises every bound interface address, private ones included, regardless of this... - [πŸ—‘οΈ Pruner Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/pruner.md): The Pruner service is a standalone microservice responsible for managing UTXO data pruning operations in Teranode. - [πŸ”— Legacy Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/legacy.md): The Legacy Service bridges the gap between the traditional BSV nodes and the advanced Teranode-BSV nodes, ensuring seamless communication and data translation between the two. - [RPC Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/rpc.md): The RPC server provides compatibility with the Bitcoin RPC interface, allowing clients to interact with the Teranode node using standard Bitcoin RPC commands. - [πŸ” UTXO Persister Service](https://bsvblockchain.com/docs/nodes/teranode/topics/services/utxo-persister.md): The UTXO Persister primary function is to create and maintain an up-to-date Unspent Transaction Output (UTXO) file set for each block in the blockchain. ###### Stores - [πŸ—‚οΈ Blob Server](https://bsvblockchain.com/docs/nodes/teranode/topics/stores/blob.md): The Blob Store is a generic datastore that can be used for any specific data model. In the current Teranode implementation, it is used to store transactions (extended tx) and subtrees. - [UTXO Store](https://bsvblockchain.com/docs/nodes/teranode/topics/stores/utxo.md): The UTXO set represents the current state of ownership of all Satoshi tokens in existence. ###### Data Model - [Teranode Data Model - Blocks](https://bsvblockchain.com/docs/nodes/teranode/topics/datamodel/block-data-model.md): The Teranode BSV model introduces a novel approach to block propagation, optimizing the network for high transaction throughput. - [Teranode Data Model - Block Header](https://bsvblockchain.com/docs/nodes/teranode/topics/datamodel/block-header-data-model.md): The block header is the fundamental data structure that chains blocks together in a blockchain. It is a fixed 80-byte structure that gets hashed as part of the proof-of-work algorithm for mining. - [Teranode Data Model - Subtrees](https://bsvblockchain.com/docs/nodes/teranode/topics/datamodel/subtree-data-model.md): The Subtrees are an innovation aimed at improving the scalability and real-time processing capabilities of the blockchain system. - [Teranode Data Model - Transaction Format Support](https://bsvblockchain.com/docs/nodes/teranode/topics/datamodel/transaction-data-model.md): Teranode supports both standard Bitcoin transaction format and Extended Transaction Format (as defined in BIP-239). - [Teranode Data Model - UTXO](https://bsvblockchain.com/docs/nodes/teranode/topics/datamodel/utxo-data-model.md): Each UTXO in the utxos array uses a variable-length binary encoding that indicates whether the output has been spent. ###### Kafka - [Kafka in Teranode](https://bsvblockchain.com/docs/nodes/teranode/topics/kafka/kafka.md): Kafka is a high-throughput, distributed messaging system designed to store and process large volumes of data. ###### Commands - [🌱 Seeder Command](https://bsvblockchain.com/docs/nodes/teranode/topics/commands/seeder.md): The Seeder is a command-line tool designed to populate the UTXO store with data up to and including a specific block. ##### Reference ###### Network and messages - [Teranode BSV Glossary](https://bsvblockchain.com/docs/nodes/teranode/references/glossary.md): Alert Service: A system that provides network alert functionality, allowing for UTXO freezing/unfreezing, UTXO reassignment, peer management, and block invalidation for network security and compliance purposes. - [Kafka Message Format Reference Documentation](https://bsvblockchain.com/docs/nodes/teranode/references/kafka-message-format.md): This document provides comprehensive information about the message formats used in Kafka topics within the Teranode ecosystem. - [Network Consensus Rules](https://bsvblockchain.com/docs/nodes/teranode/references/network-consensus-rules.md): When a block is found, there is an economic limit applied to the block size which is imposed by nodes on the network. ###### Configuration - [βš™οΈSettings](https://bsvblockchain.com/docs/nodes/teranode/references/settings.md): All services accept settings through a centralized Settings object that allows local and remote servers to have their own specific configuration. - [Comprehensive Settings Reference](https://bsvblockchain.com/docs/nodes/teranode/references/settings-reference.md): This document provides a complete reference for all Teranode configuration settings, organized by component. - [Global Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/global-settings.md): Global settings control system-wide behavior across all Teranode services. These settings affect tracing, logging, security, health checks, and profiling for the entire node. - [Policy Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/policy-settings.md): Policy settings control BSV Blockchain consensus rules and transaction validation behavior in Teranode. - [Kafka Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/kafka-settings.md): Kafka configuration in Teranode is primarily specified through URLs. Each Kafka topic has its own URL with parameters that control its behavior. ###### Service Settings - [Alert Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/alert-settings.md): GenesisKeys, ProtocolID and TopicName are empty in settings.conf. - [Asset Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/asset-settings.md): When PeerAuthAllowlist is empty (the default), signatures are still verified (replay cache + body digest + Β±10s freshness window all apply) but no tier elevation is granted β€” every authenticated peer is treated as... - [Block Assembly Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/blockassembly-settings.md): blockassemblymaxTransactionsInMemory caps the transactions block assembly holds in RAM, counted as those already placed in subtrees plus those queued for ingest. - [Blockchain Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/blockchain-settings.md): Configured RUNNING: on a checkpointed network, use only with a pre-seeded store whose tip is at or above the highest checkpoint. - [Block Persister Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/blockpersister-settings.md): Settings are organized under the BlockPersister struct in settings.Settings. - [Block Validation Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/blockvalidation-settings.md): The Default column is the loader fallback in settings/settings.go. A node uses it only when no configuration file sets the key. - [Legacy Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/legacy-settings.md): Every key below is loaded in the Legacy: LegacySettings{ block of settings/settings.go. That block is the only thing that makes a setting configurable. - [P2P Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/p2p-settings.md): All connection-limit settings default to 0 (or empty), which keeps the library default; a node that sets none of them runs with exactly the limits it had before they existed. - [Propagation Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/propagation-settings.md): Propagation Service Settings, from the Teranode documentation. - [Pruner Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/pruner-settings.md): Settings are organized under the Pruner struct in settings.Settings. - [RPC Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/rpc-settings.md): RPC Service Settings, from the Teranode documentation. - [Subtree Validation Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/subtreevalidation-settings.md): Subtree Validation Service Settings, from the Teranode documentation. - [UTXO Persister Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/utxopersister-settings.md): UTXO Persister Service Settings, from the Teranode documentation. - [Validator Service Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/services/validator-settings.md): Validator Service Settings, from the Teranode documentation. ###### Store Settings - [Aerospike Store Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/stores/aerospike-settings.md): Aerospike is a high-performance NoSQL database used as a backend for Teranode's UTXO store. These settings control Aerospike connection, policies, and performance tuning. - [Blob Store Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/stores/blob-settings.md): temp, block, block-persister, pruner-resolved and Aerospike external stores) resolve it per settings context and pass it with options.WithHTTPAuthToken - [UTXO Store Settings](https://bsvblockchain.com/docs/nodes/teranode/references/settings/stores/utxo-settings.md): These settings override the global Postgres pool settings for the UTXO store only. ###### Miscellaneous - [BIP-239 (Transaction Extended Format)](https://bsvblockchain.com/docs/nodes/teranode/misc/bip-239.md): Regular Bitcoin transactions do not contain all the data that is needed to verify that the signatures in the transactions are valid. - [Teranode License Information](https://bsvblockchain.com/docs/nodes/teranode/references/license-information.md): Teranode License Information, from the Teranode documentation. - [Teranode Prometheus Metrics Reference](https://bsvblockchain.com/docs/nodes/teranode/references/prometheus-metrics.md): All metrics are CounterVec type with labels: function (handler function name), operation (operation result). - [Daemon Reference](https://bsvblockchain.com/docs/nodes/teranode/references/teranode-daemon-reference.md): The daemon package provides core functionality for initializing and managing Teranode services. - [Teranode Third Party Software Requirements](https://bsvblockchain.com/docs/nodes/teranode/references/third-party-software-requirements.md): Teranode relies on a number of third-party software dependencies, some of which can be sourced from different vendors. ## Other pages - [BSV Developer Docs](https://bsvblockchain.com/docs/index.md): Pick your path: build a web app, run a server wallet, set up your AI, get a wallet, or learn how the BSV blockchain works.