fcoin/docs/README.md

Getting Started

• Getting Started
• Configuration
• Wallet System
• Design
• Guides

Running

• Bcoin CLI
• Running in the Browser
• REST and RPC API

Code Examples

These code examples are designed to demonstrate how to integrate bcoin modules with minimal configuration.

• Simple Fullnode - Creates a FullNode object and connects to testnet.
• Connect to Peer - Connects to a user-defined peer in regtest mode.
• Connecting to the P2P Network - Creates chain, pool, and mempool objects for both main and testnet networks.
• Creating a Blockchain and Mempool - Mines a block from the mempool to the chain.
• Wallet with Dummy TX - Adds a "dummy" transaction to the wallet and tx event is handled.
• SPV Sync - A transaction matching the SPV node's bloom filter is broadcast by a minimal full node to the SPV node.
• Plugin Example - Demonstrates the plugin feature of bcoin's node object.
• Client API Usage - Demonstrates usage of the node and wallet API.
• Miner with WorkerPool - Creates a regtest chain and miner, which mines a block using workers.
• Create and Sign TX - Demonstrates how to use mtx and keyring modules to sign a transaction.
• Get Transaction from Chain - Connects to live testnet network and syncs the first 1000 blocks with tx indexing active.
• Create Watch Only Wallet - Imports an xpub into a new watch-only wallet that can derive addresses.