### Install Nigiri Project Dependencies Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This `make` command installs the necessary dependencies for the Nigiri project. It should be run after cloning the repository to prepare the environment for building and running Nigiri. ```bash make install ``` -------------------------------- ### Start Nigiri Default Environment Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Starts the Nigiri development environment with default components, including Bitcoin Core, Electrum, and Chopsticks. This is the basic setup for Bitcoin regtest development. ```bash nigiri start ``` -------------------------------- ### Start Nigiri with Ark and Liquid Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Initializes Nigiri with Bitcoin, Ark, and the Elements/Liquid sidechain. This setup provides a comprehensive environment for both Bitcoin and Liquid development. ```bash nigiri start --ark --liquid ``` -------------------------------- ### Install Nigiri CLI Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Downloads and installs the Nigiri command-line interface using a curl pipe to bash. This script sets up the `nigiri` executable and configurable files like `bitcoin.conf`. ```bash curl https://getnigiri.vulpem.com | bash ``` -------------------------------- ### Start Nigiri with All Features Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Initializes Nigiri with Bitcoin, Ark, the Elements/Liquid sidechain, and Lightning Network nodes. This provides the most comprehensive development environment available with Nigiri. ```bash nigiri start --ark --liquid --ln ``` -------------------------------- ### Start Nigiri with Ark Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Initializes the Nigiri development environment, including Bitcoin Core, Electrum, Chopsticks, and the Ark layer two implementation. Access the blockchain explorer at `http://localhost:5000`. ```bash nigiri start --ark ``` -------------------------------- ### Start Nigiri with Ark and Lightning Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Initializes Nigiri with Bitcoin, Ark, and Lightning Network nodes (Core Lightning, LND, and Taproot Assets). This configuration is ideal for testing Lightning applications. ```bash nigiri start --ark --ln ``` -------------------------------- ### Start Nigiri with Liquid and Lightning Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Initializes Nigiri with Bitcoin, the Elements/Liquid sidechain, and Lightning Network nodes. This combines two powerful extensions for advanced blockchain development. ```bash nigiri start --liquid --ln ``` -------------------------------- ### Interact with Core Lightning, LND, and Tap CLIs via Nigiri Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This snippet demonstrates how to execute commands for Core Lightning (CLN), LND, and Tap (Taro) directly through the Nigiri interface. It includes examples for listing peers on CLN and LND, and listing assets on Tap, facilitating node management. ```bash nigiri cln listpeers nigiri lnd listpeers nigiri tap assets list ``` -------------------------------- ### Clean Nigiri Build Artifacts Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This `make` command removes build artifacts and cleans the Nigiri project directory. It is recommended to run this command before installing a new version to ensure a clean upgrade and prevent conflicts. ```bash make clean ``` -------------------------------- ### Forget Remembered Nigiri Flags Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Removes any flags previously saved using `nigiri start --remember`. This ensures that subsequent `nigiri start` calls will use default settings unless new flags are explicitly provided. ```bash nigiri forget ``` -------------------------------- ### Generate New Liquid Address using Nigiri RPC Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This command enables interaction with the Elements CLI within the Nigiri setup. It shows how to generate a new Bech32 Liquid address using the `getnewaddress` RPC call, specifying the `--liquid` flag for Liquid-specific operations. ```bash nigiri rpc --liquid getnewaddress "" "bech32" ``` -------------------------------- ### Build Nigiri Executable Binary Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This `make` command compiles the Nigiri source code into an executable binary. The resulting binary will be located in the `./build` folder, ready for execution. ```bash make build ``` -------------------------------- ### Interact with Ark CLI and Daemon using Nigiri Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This comprehensive snippet provides commands for interacting with both the Ark client and daemon through Nigiri. It includes checking versions, managing wallet configuration, receiving addresses, checking balances, and initializing the Ark client and daemon for development. ```bash nigiri ark --version nigiri arkd --version nigiri ark config nigiri ark receive nigiri ark balance nigiri arkd wallet status nigiri arkd wallet create --password secret nigiri arkd wallet unlock --password secret nigiri arkd wallet status nigiri ark init --network regtest --password secret --server-url localhost:7070 --explorer http://chopsticks:3000 ``` -------------------------------- ### Clone Nigiri Git Repository Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This command clones the Nigiri project repository from GitHub. It is the first step in setting up Nigiri from scratch, providing access to the source code and project files. ```bash git clone https://github.com/vulpemventures/nigiri.git ``` -------------------------------- ### Launch Docker Daemon on macOS Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Opens the Docker application on macOS to ensure the Docker daemon is running. This is a prerequisite for Nigiri to function correctly. ```bash open -a Docker ``` -------------------------------- ### Fund Core Lightning Node (Faucet) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Funds the Core Lightning node with a specified amount of Bitcoin. This command simplifies providing liquidity to your CLN for testing transactions. ```bash nigiri faucet cln 0.01 ``` -------------------------------- ### Fund LND Node (Faucet) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Funds the LND node with a specified amount of Bitcoin. This command simplifies providing liquidity to your LND for testing transactions. ```bash nigiri faucet lnd 0.01 ``` -------------------------------- ### Connect Core Lightning to LND using Nigiri Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This command facilitates connecting a Core Lightning node to an LND node within the Nigiri environment. It dynamically retrieves the LND node's public key to establish the connection, simplifying inter-node communication. ```bash nigiri cln connect `nigiri lnd getinfo | jq -r .identity_pubkey`@lnd:9735 ``` -------------------------------- ### Open Lightning Channel between CLN and LND via Nigiri Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This snippet illustrates the process of opening a Lightning channel between a Core Lightning node and an LND node using Nigiri. It involves both LND initiating the channel opening and CLN funding a channel to LND, crucial for Lightning network testing. ```bash nigiri lnd openchannel --node_key=`nigiri cln getinfo | jq -r .id` --local_amt=100000 nigiri cln fundchannel `nigiri lnd getinfo | jq -r .identity_pubkey` 100000 ``` -------------------------------- ### Fund Bitcoin Address (Faucet) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Generates and sends Bitcoin to a specified Bitcoin address on the regtest network. This is useful for quickly obtaining funds for testing. ```bash nigiri faucet ``` -------------------------------- ### Send Specific Liquid Asset (Faucet) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Sends a specified quantity of a particular Liquid asset to a given Liquid address. This allows for precise control over asset distribution in your test environment. ```bash nigiri faucet --liquid ``` -------------------------------- ### Fund Liquid Address (Faucet) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Generates and sends Liquid assets to a specified Liquid address. This is used for obtaining Liquid funds for development and testing. ```bash nigiri faucet --liquid ``` -------------------------------- ### Issue and Send Liquid Asset (Mint) Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Issues a new Liquid asset with a specified quantity and sends it to a given Liquid address. This command is exclusive to the Liquid network for creating custom tokens. ```bash nigiri mint 1000 VulpemToken VLP ``` -------------------------------- ### Check Electrs Logs Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Displays the logs for the Electrum backend service (electrs) running in Nigiri. Use this to monitor the Electrum explorer's operations. ```bash nigiri logs electrs ``` -------------------------------- ### Pay Lightning Invoices between CLN and LND via Nigiri Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This snippet demonstrates how to facilitate invoice payments between Core Lightning and LND nodes using Nigiri. It covers both LND paying a CLN-generated invoice and CLN paying an LND-generated invoice, essential for testing payment flows. ```bash nigiri lnd payinvoice `nigiri cln invoice 21000 $(date +%s) "test" | jq -r .bolt11` nigiri cln pay `nigiri lnd addinvoice 21 | jq -r .payment_request` ``` -------------------------------- ### Check Logs for Nigiri Liquid Services Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This snippet demonstrates how to view logs for various Liquid-related services managed by Nigiri, including Elementsd, Electrs Liquid, and Chopsticks Liquid. It helps in debugging and monitoring the status of these components within your local environment. ```bash nigiri logs liquid nigiri logs electrs-liquid nigiri logs chopsticks-liquid ``` -------------------------------- ### Check Logs for Nigiri Lightning Services Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This snippet shows how to access logs for Core Lightning (CLN) and LND services running within the Nigiri environment. It's useful for monitoring the health and activity of your Lightning nodes and troubleshooting issues. ```bash nigiri logs cln nigiri logs lnd ``` -------------------------------- ### Check Bitcoin Node Logs Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Displays the logs for the Bitcoin Core service running in Nigiri. This is useful for debugging and monitoring the Bitcoin node's activity. ```bash nigiri logs bitcoin ``` -------------------------------- ### Update Nigiri Docker Images Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This command allows users to update the underlying Docker images used by Nigiri. It ensures that all components are running the latest versions, which is crucial for maintaining a stable and up-to-date development environment. ```bash nigiri update ``` -------------------------------- ### Generate New Bitcoin Address using Nigiri RPC Source: https://github.com/vulpemventures/nigiri/blob/master/README.md This command allows users to interact with the Bitcoin CLI directly from within the Nigiri environment. It demonstrates how to generate a new Bech32 Bitcoin address using the `getnewaddress` RPC call, useful for testing and development. ```bash nigiri rpc getnewaddress "" "bech32" ``` -------------------------------- ### Broadcast Bitcoin Raw Transaction Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Broadcasts a raw Bitcoin transaction (in hexadecimal format) to the regtest network. A new block is automatically generated to include the transaction. ```bash nigiri push ``` -------------------------------- ### Chopsticks Service API Endpoints Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Documentation for the extended Esplora API endpoints exposed by the Nigiri Chopsticks service on port 3000 (and 3001 for Liquid). These endpoints provide additional functionality for Bitcoin and Liquid networks, including faucet, transaction handling, asset minting, and registry lookups. ```APIDOC Chopsticks Service API Endpoints: Bitcoin & Liquid: POST /faucet Description: Provides funds to a given address. Body: { "address": } POST /tx Description: Extends standard transaction submission to automatically mine a block upon call. Body: Standard transaction payload. Liquid only: POST /mint Description: Mints new Liquid assets. Body: { "address": "ert1q90dz89u8eudeswzynl3p2jke564ejc2cnfcwuq", "quantity": 1000, "name":"VULPEM", "ticker":"VLP" } POST /registry Description: Retrieves extra information (name, ticker) about one or more Liquid assets. Body: { "assets": ["2dcf5a8834645654911964ec3602426fd3b9b4017554d3f9c19403e7fc1411d3"] } ``` -------------------------------- ### Check Chopsticks Logs Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Displays the logs for the Chopsticks JSON HTTP proxy service running in Nigiri. This helps in debugging issues related to Nigiri's custom API endpoints. ```bash nigiri logs chopsticks ``` -------------------------------- ### Broadcast Liquid Raw Transaction Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Broadcasts a raw Liquid transaction (in hexadecimal format) to the Liquid regtest network. A new block is automatically generated to include the transaction. ```bash nigiri push --liquid ``` -------------------------------- ### Stop Nigiri Containers Source: https://github.com/vulpemventures/nigiri/blob/master/README.md Stops all running Docker containers managed by Nigiri. Use the `--delete` flag to also remove containers, config files, and volume data. ```bash nigiri stop ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.