# SUBFROST Documentation

> Official docs for SUBFROST on Bitcoin L1: frBTC, frUSD, DIESEL, FIRE, the Alkanes metaprotocol, the SUBFROST API and alkanes-cli.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Get Started in 5 Minutes](https://docs.subfrost.io/start-here/get-started.md): Pick a wallet, add Bitcoin, and make your first swap on SUBFROST.
- [Key Concepts](https://docs.subfrost.io/start-here/key-concepts.md): A quick glossary of SUBFROST covering frBTC, DIESEL, FIRE, FUEL, dxBTC, the AMM, and the tech underneath.
- [What is SUBFROST](https://docs.subfrost.io/start-here/what-is-subfrost.md): SUBFROST in plain terms. Put your Bitcoin to work in DeFi without handing it to a company and without leaving Bitcoin.
- [BTCUSD Pool](https://docs.subfrost.io/using-subfrost/btcusd-pool.md): The frUSD/frBTC pool, where BTC trades against the dollar without leaving Bitcoin.
- [FIRE Vault](https://docs.subfrost.io/using-subfrost/fire-vault.md): Stake liquidity to earn FIRE, or buy FIRE at a discount through bonds.
- [Futures](https://docs.subfrost.io/using-subfrost/futures.md): Futures on SUBFROST are coming soon.
- [Lending](https://docs.subfrost.io/using-subfrost/lending.md): Lend your tokens to earn interest, or borrow against collateral, settled peer-to-peer on Bitcoin L1.
- [Pay Fees in DIESEL](https://docs.subfrost.io/using-subfrost/pay-fees-in-diesel.md): Pay the Bitcoin network fee with DIESEL instead of BTC in the SUBFROST wallets.
- [Pools & Liquidity](https://docs.subfrost.io/using-subfrost/pools-liquidity.md): Provide liquidity to SUBFROST pools and earn a share of swap fees.
- [Safety](https://docs.subfrost.io/using-subfrost/safety.md): Keep your Ordinals, Runes and BRC-20 assets safe when using SUBFROST.
- [Swap](https://docs.subfrost.io/using-subfrost/swap.md): Trade Bitcoin assets on SUBFROST, settled natively on Bitcoin.
- [Wallets](https://docs.subfrost.io/using-subfrost/wallets.md): Create or connect a Bitcoin wallet for SUBFROST, manage your balances and UTXOs, and send and receive BTC.
- [Wrap & Unwrap BTC](https://docs.subfrost.io/using-subfrost/wrap-unwrap-frbtc.md): Turn your Bitcoin into frBTC and back, 1:1, without leaving Bitcoin.
- [Overview](https://docs.subfrost.io/tokens-economics/overview.md): The assets that make up the SUBFROST economy and how they fit together.
- [FUEL Token](https://docs.subfrost.io/tokens/FUEL-token.md): :::note[FUEL is not a gas token]
- [dxBTC Overview](https://docs.subfrost.io/tokens/dxBTC-overview.md): dxBTC is a planned yield-bearing BTC token: deposits will be wrapped to frBTC and deployed into market-neutral strategies, with yield paid in BTC. ...
- [frBTC (DeFi-compatible BTC)](https://docs.subfrost.io/tokens/frBTC-overview.md): frBTC is BTC wrapped 1:1 on Bitcoin L1 (Alkane ID 32:0), usable across Alkanes and BRC2.0 DeFi.
- [frUSD (Bitcoin-native stablecoin)](https://docs.subfrost.io/tokens/frUSD-overview.md): `frUSD` is a US-dollar token that lives on Bitcoin L1 as an [Alkanes](../protocol/alkanes) asset. It holds an ordinary Bitcoin UTXO, moves in an or...
- [Alkanes Metaprotocol](https://docs.subfrost.io/protocol/alkanes.md): The smart-contract metaprotocol on Bitcoin that SUBFROST is built on.
- [BRC2.0 Metaprotocol](https://docs.subfrost.io/protocol/brc20.md): BRC2.0 brings EVM-compatible smart contracts to Bitcoin, and SUBFROST assets connect to it.
- [How DIESEL Fees Work](https://docs.subfrost.io/protocol/diesel-fees.md): How SUBFROST wallets let you pay the Bitcoin miner fee in DIESEL, inside a single transaction.
- [frBTC Peg & Custody](https://docs.subfrost.io/protocol/frbtc-peg-and-custody.md): How frBTC stays backed 1:1 by real BTC, secured by threshold signing.
- [frUSD Deposits from Other Chains](https://docs.subfrost.io/protocol/frusd-cross-chain-deposits.md): How a stablecoin deposit on BNB Chain, Polygon or Base becomes frUSD on Bitcoin, through one signed intent, a deposit address that exists only on E...
- [Lending Protocol](https://docs.subfrost.io/protocol/lending.md): How a peer-to-peer loan settles in one Bitcoin transaction, using a pre-signed PSBT escrow.
- [Signing and Keys](https://docs.subfrost.io/protocol/signing-and-keys.md): The cryptography behind SUBFROST custody, Schnorr signatures, threshold signing, distributed key generation, and how keys are protected on your dev...
- [The Oracle](https://docs.subfrost.io/protocol/the-oracle.md): How SUBFROST brings outside data on-chain in a decentralized way.
- [BRC2.0 Integration](https://docs.subfrost.io/build/brc20-integration.md): Deploy and call EVM-style Solidity contracts on Bitcoin through BRC2.0.
- [Connecting a wallet](https://docs.subfrost.io/build/connecting-a-wallet.md): Let a web app request signatures from a SUBFROST wallet, through the injected provider or remote signing.
- [Indexing with metashrew](https://docs.subfrost.io/build/indexing-with-metashrew.md): How Alkanes state is indexed, how view functions work, and how to run the indexer yourself.
- [Interacting via the CLI](https://docs.subfrost.io/build/interacting-via-cli.md): Use alkanes-cli to manage a wallet, deploy and call contracts, and query the chain.
- [Build on SUBFROST](https://docs.subfrost.io/build/overview.md): What you can build on SUBFROST and Alkanes, the tools you will use, and where to start.
- [Quickstart](https://docs.subfrost.io/build/quickstart.md): Install the toolchain, write a minimal Alkanes contract, and deploy it to Bitcoin.
- [Reproducible builds](https://docs.subfrost.io/build/reproducible-builds.md): The reproduction formula behind alkane verification, covering the registry time-machine, git source-ids, HOME, clang, and cross-host toolchains.
- [Verifying alkanes](https://docs.subfrost.io/build/verifying-alkanes.md): How the SUBFROST explorer proves that an alkane's on-chain bytecode was built from a given source, and what each verdict means.
- [Wrapping frBTC](https://docs.subfrost.io/build/wrapping-frbtc.md): Wrap BTC into frBTC and unwrap it back, from the CLI and from TypeScript.
- [Alkanes Commands](https://docs.subfrost.io/api-reference/cli-sdk/alkanes.md): Contract execution, token queries, AMM swaps, and liquidity pool management with alkanes-cli.
- [BRC20-Prog Commands](https://docs.subfrost.io/api-reference/cli-sdk/brc20-prog.md): Deploy and interact with EVM-compatible smart contracts on Bitcoin via alkanes-cli.
- [BTC/USD Commands](https://docs.subfrost.io/api-reference/cli-sdk/btcusd.md): Trade BTC against USD with alkanes-cli - the frUSD/frBTC pool, both bridge arms, and the mempool reads.
- [BuildInfo Workbench](https://docs.subfrost.io/api-reference/cli-sdk/build-info.md): Reverse, rebuild, diff, and upload an alkane's wasm with the alkanes-cli build-info and upload commands.
- [DataAPI Commands](https://docs.subfrost.io/api-reference/cli-sdk/dataapi.md): High-level queries for Alkanes tokens, AMM pools, balances, and market data via alkanes-cli.
- [Esplora Commands](https://docs.subfrost.io/api-reference/cli-sdk/esplora.md): Block explorer queries for blocks, transactions, addresses, and fee estimates with alkanes-cli.
- [Espo Commands](https://docs.subfrost.io/api-reference/cli-sdk/espo.md): Query the Espo indexer for alkanes balances, holders, candles, and swap routing with alkanes-cli.
- [Installation](https://docs.subfrost.io/api-reference/cli-sdk/installation.md): Install alkanes-cli from source and set up the @alkanes/ts-sdk TypeScript library.
- [Ord Commands](https://docs.subfrost.io/api-reference/cli-sdk/ord.md): Query inscriptions, runes, and satoshi information from the Ordinals protocol with alkanes-cli.
- [alkanes-cli & @alkanes/ts-sdk](https://docs.subfrost.io/api-reference/cli-sdk/overview.md): Command-line and TypeScript SDK access to the Alkanes protocol, Bitcoin blockchain, and SUBFROST APIs.
- [Wallet Commands](https://docs.subfrost.io/api-reference/cli-sdk/wallet.md): HD wallet management, address derivation, transaction signing, and balance queries with alkanes-cli.
- [Authentication](https://docs.subfrost.io/api-reference/getting-started/authentication.md): API keys, headers, CORS, and alias routes for authenticating with the SUBFROST API.
- [Introduction](https://docs.subfrost.io/api-reference/getting-started/overview.md): The SUBFROST API is the developer gateway to Bitcoin, Ordinals, BRC-20, and Alkanes data, plus the SUBFROST protocol.
- [Quickstart](https://docs.subfrost.io/api-reference/getting-started/quickstart.md): Make your first SUBFROST API request in a few minutes.
- [Reading Alkane Metadata](https://docs.subfrost.io/api-reference/guides/alkane-metadata.md): Discover a deployed alkane's ABI (methods, opcodes, parameters) from its on-chain wasm using the __meta export.
- [SUBFROST WalletConnect](https://docs.subfrost.io/api-reference/guides/walletconnect.md): Pair a web app with the SUBFROST mobile wallet over the pair bridge and request PSBT and message signatures. Full wire protocol for dapp and wallet...
- [alkanes_* Methods](https://docs.subfrost.io/api-reference/json-rpc/alkanes.md): Alkanes protocol methods for tokens, bytecode, simulation, and metadata, plus their metashrew_view mappings.
- [Bitcoin Core RPC](https://docs.subfrost.io/api-reference/json-rpc/bitcoind.md): btc_* passthrough methods for Bitcoin Core RPC, covering blocks, blockchain info, transactions, mempool, and fee estimation.
- [BRC20 Programmable Module (JSON-RPC)](https://docs.subfrost.io/api-reference/json-rpc/brc20-prog.md): Ethereum-compatible JSON-RPC methods for the BRC-20 Programmable Module, plus precompiled contracts and the BRC20_Controller.
- [BTC/USD Pool](https://docs.subfrost.io/api-reference/json-rpc/btcusd.md): Protobuf views over metashrew_view for the SUBFROST BTC/USD pool, covering reserves, LP supply, prices, trades, and OHLC candles.
- [esplora_* Methods](https://docs.subfrost.io/api-reference/json-rpc/esplora.md): Electrs/Esplora block explorer methods for addresses, transactions, blocks, mempool, and fee estimation.
- [Espo JSON-RPC API](https://docs.subfrost.io/api-reference/json-rpc/espo.md): Espo indexer JSON-RPC methods for alkanes balances, holders, storage keys, and AMM analytics.
- [Foreign Exchange (Fiat)](https://docs.subfrost.io/api-reference/json-rpc/forex.md): forex_* methods for fiat exchange rates and conversions, returned as decimal strings with explicit missing currencies.
- [frUSD Deposits (Ethereum)](https://docs.subfrost.io/api-reference/json-rpc/frusd.md): Protobuf views for frUSD deposits made on Ethereum, indexed by BTC recipient script.
- [metashrew_* Methods](https://docs.subfrost.io/api-reference/json-rpc/metashrew.md): Metashrew indexer methods for WASM-based blockchain views, including protorunes and alkane metadata lookups.
- [ord_* Methods](https://docs.subfrost.io/api-reference/json-rpc/ord.md): Ordinals protocol methods for inscriptions, runes, satoshis, outputs, and addresses.
- [JSON-RPC API Overview](https://docs.subfrost.io/api-reference/json-rpc/overview.md): The SUBFROST JSON-RPC interface, its namespaces, request and response formats, batching, and error codes.
- [lua_evalsaved](https://docs.subfrost.io/api-reference/lua/evalsaved.md): Execute a previously saved Lua script by its SHA256 hash, for lower bandwidth and faster parsing than lua_evalscript.
- [lua_evalscript](https://docs.subfrost.io/api-reference/lua/evalscript.md): Execute a Lua script directly with optional arguments and full RPC access.
- [Lua Script Examples](https://docs.subfrost.io/api-reference/lua/examples.md): Real-world Lua scripts demonstrating common use cases, including multicall, balance aggregation, and confirmation checks.
- [Lua Scripting Overview](https://docs.subfrost.io/api-reference/lua/overview.md): Execute server-side Lua scripts with full RPC access to reduce round trips and combine related queries.
- [lua_savescript](https://docs.subfrost.io/api-reference/lua/savescript.md): Save a Lua script to the server and receive its SHA256 hash for repeated, low-bandwidth execution.
- [Ethereum Mempool (Preview)](https://docs.subfrost.io/api-reference/mempool/ethereum.md): A live view of the Ethereum public mempool over JSON-RPC and a WebSocket change stream.
- [Mempool JSON-RPC](https://docs.subfrost.io/api-reference/mempool/jsonrpc.md): mempool_* JSON-RPC methods for mempool queries, paginated snapshots, and the fee-rate histogram.
- [Mempool API](https://docs.subfrost.io/api-reference/mempool/overview.md): A live view of the Bitcoin mempool over JSON-RPC and a sequenced WebSocket change stream.
- [Mempool WebSocket](https://docs.subfrost.io/api-reference/mempool/websocket.md): The mempool WebSocket stream, covering subscriptions, frames, resync without a gap, and backpressure.
- [Orderbook (Beta)](https://docs.subfrost.io/api-reference/orderbook/overview.md): A live read and stream API over the off-chain PSBT order books for orbitals and lending.
- [Orderbook REST](https://docs.subfrost.io/api-reference/orderbook/rest.md): REST endpoints for orderbook markets, market snapshots, and single orders.
- [Orderbook WebSocket](https://docs.subfrost.io/api-reference/orderbook/websocket.md): The orderbook WebSocket firehose. Subscribe to a market topic, receive a snapshot, then live deltas.
- [API Keys](https://docs.subfrost.io/api-reference/platform/api-keys.md): Create, use, and manage SUBFROST API keys, including security best practices and environment variable setup.
- [CORS Authentication](https://docs.subfrost.io/api-reference/platform/cors.md): Register a domain for browser-based access to the SUBFROST API without exposing API keys client-side.
- [API Platform Overview](https://docs.subfrost.io/api-reference/platform/overview.md): The SUBFROST API Platform dashboard for managing API access, monitoring usage, and configuring authentication.
- [Rate Limits](https://docs.subfrost.io/api-reference/platform/rate-limits.md): SUBFROST API rate limit plans, response headers, error handling, and usage optimization strategies.
- [Reorg Endpoint](https://docs.subfrost.io/api-reference/platform/reorg.md): A fake bitcoind RPC that rolls a rockshrew-mono indexer back to a chosen block height so it can re-index under a new wasm.
- [Database Rsync Access](https://docs.subfrost.io/api-reference/platform/rsync.md): Business-tier rsync access to sync Esplora, Ord, Metashrew, and Bitcoin Core blockchain database snapshots directly.
- [Snapshot Download](https://docs.subfrost.io/api-reference/platform/snapshots.md): Bootstrap a metashrew RocksDB index from the public mainnet snapshot tarball instead of indexing from genesis.
- [Alkanes REST Endpoints](https://docs.subfrost.io/api-reference/rest/alkanes.md): REST endpoints for querying alkane tokens, contracts, and holdings.
- [Bitcoin Data REST Endpoints](https://docs.subfrost.io/api-reference/rest/bitcoin.md): REST endpoints for Bitcoin price data, address balances, UTXOs, and history.
- [History REST Endpoints](https://docs.subfrost.io/api-reference/rest/history.md): REST endpoints for AMM transaction history, including swaps, mints, burns, and wraps.
- [OPI (BRC-20 Indexer) REST API](https://docs.subfrost.io/api-reference/rest/opi.md): OPI-standard REST endpoints for indexed BRC-20 token data on the SUBFROST API.
- [REST API Overview](https://docs.subfrost.io/api-reference/rest/overview.md): High-level REST endpoints for alkanes, AMM pools, and blockchain data on the SUBFROST API.
- [Pools & AMM REST Endpoints](https://docs.subfrost.io/api-reference/rest/pools.md): REST endpoints for querying and interacting with alkanes AMM liquidity pools.
- [Source API](https://docs.subfrost.io/api-reference/verification/source-api.md): Read a verified alkane's provenance, file tree, and file contents from the SUBFROST explorer API.
- [Verify and Attest](https://docs.subfrost.io/api-reference/verification/verify-and-attest.md): Submit an alkane's source to the SUBFROST explorer for a sandboxed rebuild, or record an out-of-band verification with an admin key.
- [Glossary](https://docs.subfrost.io/reference/glossary.md): Short definitions for the terms used across the SUBFROST documentation.
- [Alkanes Integration](https://docs.subfrost.io/developer-guide/alkanes-integration.md): The Alkanes CLI (`alkanes-cli`) is the primary command-line tool for interacting with the Alkanes metaprotocol on Bitcoin. It provides commands for...
- [BRC2.0 (brc20-prog)](https://docs.subfrost.io/developer-guide/brc20-prog.md): While Alkanes uses a binary protocol for token operations, BRC2.0 uses standard ord inscriptions with JSON payloads to enable general-purpose compu...
- [FR-BTC on BRC2.0](https://docs.subfrost.io/developer-guide/frBTC-brc20.md): FR-BTC provides two powerful functions for building composable DeFi applications on BRC2.0: `wrapAndExecute` and `wrapAndExecute2`. These functions...
- [Reading Alkanes data from Bitcoin](https://docs.subfrost.io/developer-guide/reading-alkanes-data.md): How to get Alkanes data out of Bitcoin (run the Alkanes indexer, index the /traces feed with your own program, or decode each transaction's message...
- [frBTC on Alkanes](https://docs.subfrost.io/developer-guide/wrapping-frBTC.md): frBTC is the native Bitcoin synthetic token on the Alkanes metaprotocol, pegged 1:1 to BTC. This guide covers wrapping, unwrapping, and interacting...
- [Alkanes Metaprotocol](https://docs.subfrost.io/key-components/alkanes.md): The Alkanes Metaprotocol is a powerful system for creating stateful, smart contract-like applications on top of the Bitcoin blockchain. It is the e...
- [BRC2.0 Protocol](https://docs.subfrost.io/key-components/brc20-prog.md): BRC2.0 (also known as brc20-prog) is a protocol for deploying and executing EVM-compatible smart contracts directly on Bitcoin via inscriptions. It...
- [FROST & ROAST Cryptography for Signing](https://docs.subfrost.io/key-components/frost-and-roast.md): **Flexible Round-Optimized Schnorr Threshold (FROST)** and **Robust Asynchronous Schnorr Threshold (ROAST)** signatures are the cryptographic corne...
- [Keystore Management](https://docs.subfrost.io/key-components/keystore-management.md): In SUBFROST, a **keystore** is a file that securely stores all the sensitive cryptographic material for a user. This includes the user's master sec...
- [Lending Protocol](https://docs.subfrost.io/key-components/lending.md): :::note Audience
- [Schnorr Signatures](https://docs.subfrost.io/key-components/schnorr-signatures.md): Schnorr signatures are a type of digital signature scheme that is known for its simplicity, provable security, and linearity. They are a key buildi...