@omnibtc/ordinals-cli-tool
v1.0.18
Published
This project is a command line interface for minting inscriptions on the Bitcoin network. It makes use of the bitcoinjs-lib library and axios for handling HTTP requests.
Downloads
43
Readme
This project is a command line interface for minting inscriptions on the Bitcoin network. It makes use of the bitcoinjs-lib library and axios for handling HTTP requests.
ord-server
ord_server --chain=main --data-dir=./data --ip=0.0.0.0 --bitcoin-data-dir=./.bitcoin --bitcoin-rpc-user=qinghuan --bitcoin-rpc-pass=95951121a --rpc-url=http://127.0.0.1:8332/wallet/ord --service-fee 600 --service-address bc1phsaern0qpcpqpv2h6cmu6fgae4y0lyx2tqhmqmgvv7c9whffm3rq9nfv6l
Installation
Before you begin, ensure you have Node.js installed on your machine. You can download Node.js from here.
- Clone the repo
git clone [email protected]:coming-chat/ordinals-cli-tool.git
- Install NPM packages
npm install
Configuration
Before using the CLI, you need to set up the .env
file with the right network (mainnet or testnet) and your private key:
.env
PRIVATE_KEY='YOUR_PRIVATE_KEY'
Usage
Once everything is set up, you can use the mint
command to mint a new inscription. The command takes three parameters:
<fee-rate>
: The fee rate in satoshis per byte.<source>
: The source Bitcoin address.<content>
: The content to be inscribed.
Here is an example of how to use it:
yarn cli mint 17 1 bc1pa5d3r64jx8zvu80re2sgtesf5yn4ya4a6r6rdtxk0xqhjf4n4vzq2dtv2l bc1pvc3lt8ejsxfwh8u98k2vglc699nkxjd9rk5x8e4mvwqqym4ftftsm8nqq9 "{\"p\":\"brc-20\",\"op\":\"mint\",\"tick\":\"sats\",\"amt\":\"100000000\"}"
Replace yourscript.js
with the actual name of your script. Also replace the fee rate, source address, and content with your own.
This will print the signed commit transaction and the IDs of the reveal transactions to the console.
License
Distributed under the MIT License. See LICENSE
for more information.