https://github.com/bihelix-io/bihelix-rgb-cli

https://github.com/bihelix-io/bihelix-rgb-cli

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/bihelix-io/bihelix-rgb-cli
• Owner: bihelix-io
• License: mit
• Created: 2024-03-06T05:48:34.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-27T02:59:46.000Z (9 months ago)
• Last Synced: 2024-08-01T13:22:21.838Z (4 months ago)
• Language: Rust
• Size: 1.06 MB
• Stars: 10
• Watchers: 1
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-rgb-protocol - Bihelix RGB CLI

README

        

# BiHelix RGB CLI

Introducing the revolutionary RGB command-line tool, meticulously crafted by the BiHelix Team. Leveraging the power of the Bitcoin Development Kit and the latest rgb v0.11 libraries, this tool empowers users to seamlessly import, export, issue, and inquire about their off-chain RGB20 assets. 

`Please note, at this stage, users can import and inquire about their rgb20 assets using this cutting-edge CLI tool, with forthcoming support for more asset categories transfer. Stay tuned as we continue to innovate and elevate the Bitcoin blockchain experience.`

# Requirements

Before run this repo, please check whether or not your `rust` version satisfy `1.76`, if not, please update it to the `1.76` version(Or the latest stable version).

# Installation

Clone the repo from the github and compile it.

```bash

git clone https://github.com/bihelix-io/bihelix-rgb-cli

cd bihelix-rgb-cli

cargo build --release

cd ./target/release

```

# Troubleshoot

## amplify_num issue

Encountering the error shown in the image, please run `sudo cargo update amplify_num --precise 0.5.1` then, run `sudo cargo build --release` again.

![amplify_num issue](img/issue.png)

# Usage

## Prepare the data

- Get the RGB20 token `contract id`

- Create `./data/bitcoin` directory if not exists

- Copy `stock.dat` file into `./data/bitcoin` directory

## Query the RGB20 asset

Execute query cmd as followed.

```bash

./bihelix-rgb-cli -n bitcoin rgb -d ./data state  RGB20 --address 

```

## Balance of RGB20 Asset

![balance](img/asset.png)