To complete the demo, you need to set up the following toolchains:
First, clone it from GitHub:
git clone https://github.com/RGB-WG/rgb.gitThen, build it, copy the binary to ~/.cargo/bin/:
cd rgb
cargo build --package rgb-wallet --bin rgb --release
cp target/release/rgb ~/.cargo/bin/
Run make up to start the development environment
git clone https://github.com/bitlightlabs/bitlight-local-env-public/
make upWrite down Alice's xprv and Bitcoin address.
make alice-cli
Network : regtest
Wallet Name : alice
Root XPRV : tprv8ZgxMBicQKsPeHzjP5LTL818LxwHbJNLZRa98Qdnn7M98fW15365cB1Sz9QZvYufASRKH6JEPhfpxVuFTKMHxDcEAVboqKuZdMmxzKVhMnW
Fixed XPUB : [5183a8d8/86'/1'/0']tpubDDtdVYn7LWnWNUXADgoLGu48aLH4dZ17hYfRfV9rjB7QQK3BrphnrSV6pGAeyfyiAM7DmXPJgRzGoBdwWvRoFdJoMVpWfmM9FCk8ojVhbMS/<0;1;9;10>/*
Bitcoin Address : bcrt1pn0s2pajhsw38fnpgcj79w3kr3c0r89y3xyekjt8qaudje70g4shs20nwfx
Write down Bob's xprv and Bitcoin address.
make bob-cli
Network : regtest
Wallet Name : bob
Root XPRV : tprv8ZgxMBicQKsPeEP6QyHbs7W2pfW5FJisXLcX93h2AnH5Kx8fuhKz7FYm4kw46SUgXJd3zUKwNoTqxtpLw7vmtLeFUGJb6XSeom45hQjeXxJ
Fixed XPUB : [3abb3cbb/86'/1'/0']tpubDDeBXqUqyVcbe75SbHAPNXMojntFu5C8KTUEhnyQc74Bty6h8XxqmCavPBMd1fqQQAAYDdp6MAAcN4e2eJQFH3v4txc89s8wvHg98QSUrdL/<0;1;9;10>/*
Bitcoin Address : bcrt1plphl407vyfpml2thhypzuqk232256njnaw4zhtmyrrku66pqn9usx4x59h
get satoshis faucet for alice and bob
make core-cli
load_wallet
# alice
send bcrt1pn0s2pajhsw38fnpgcj79w3kr3c0r89y3xyekjt8qaudje70g4shs20nwfx 1
send bcrt1plphl407vyfpml2thhypzuqk232256njnaw4zhtmyrrku66pqn9usx4x59h 1
# bob
send bcrt1p9yjaffzhuh9p7d9gnwfunxssngesk25tz7rudu4v69dl6e7w7qhq5x43k5 1
mint 1
To create a RGB20 contract, just clone this repo to you local machine. Then compile and run it.
$ git clone https://github.com/bitlightlabs/bitlight-rgb20-contract
$ cd bitlight-rgb20-contractedit main.rs, change the beneficiary to alice's address
let beneficiary_txid =
Txid::from_hex("d6afd1233f2c3a7228ae2f07d64b2091db0d66f2e8ef169cf01217617f51b8fb").unwrap();
let beneficiary = Outpoint::new(beneficiary_txid, 1);Export ESPLORA_SERVER env for esplora-api endpoint:
$ export LNPBP_NETWORK=regtest
$ export ESPLORA_SERVER="http://esplora-api.bitlight-local-env.orb.local:3000"note: a locally running bitlight-local-env-esplora-api docker container instance should export ESPLORA_SERVER value:
$ export ESPLORA_SERVER="http://localhost:3002" and locally running bitlight-local-env-esplora (server / non-api) docker container client constructor parameter in src/bin/broadcast_tx.rs set to:
esplora_client::Builder::new("http://localhost:5002") Now, we are creating a RGB20 #TEST contract, which stores in examples folder
$ make run
The issued contract data:
{"ticker":"TEST","name":"Test asset","details":null,"precision":"centiMicro"}
amount=adMhBHaQ, owner=bc:tapret1st:311ec7d43f0f33cda5a0c515a737b5e0bbce3896e6eb32e67db0e868a58f4150:1, witness=~
totalSupply=adMhBHaQ
Contracts are available in the examples directory
---------------------------------
./examples:
-rw-r--r-- 1 bitlight staff 21364 Mar 15 19:57 rgb20-simplest.rgb
-rw-r--r-- 1 bitlight staff 27456 Mar 15 19:57 rgb20-simplest.rgba
---------------------------------Before importing contracts, let's import our wallets to rgb.
Create rgb wallet container for Alice:
$ rgb -d .alice create default --tapret-key-only <alice-fixed-xpub-descriptor>
$ rgb -d .alice create default --tapret-key-only "[5183a8d8/86'/1'/0']tpubDDtdVYn7LWnWNUXADgoLGu48aLH4dZ17hYfRfV9rjB7QQK3BrphnrSV6pGAeyfyiAM7DmXPJgRzGoBdwWvRoFdJoMVpWfmM9FCk8ojVhbMS/<0;1;9;10>/*"
Loading descriptor from command-line argument ... success
Syncing keychain 0 ........... keychain 1 .......... keychain 9 .......... keychain 10 .......... success
Saving the wallet as 'default' ... success
$ rgb -d .alice utxos
Height Amount, ṩ Outpoint
bcrt1pn0s2pajhsw38fnpgcj79w3kr3c0r89y3xyekjt8qaudje70g4shs20nwfx &0/0
102 100000000 d6afd1233f2c3a7228ae2f07d64b2091db0d66f2e8ef169cf01217617f51b8fb:1
Loading descriptor from wallet default ... success
Wallet total balance: 100000000 ṩ
Create rgb wallet container for Bob:
$ rgb -d .bob create default --tapret-key-only <bob-fixed-xpub-descriptor>
Loading descriptor from command-line argument ... success
Syncing keychain 0 ........... keychain 1 .......... keychain 9 .......... keychain 10 .......... success
Saving the wallet as 'default' ... success
$ rgb -d .bob utxos
Height Amount, ṩ Outpoint
bcrt1plphl407vyfpml2thhypzuqk232256njnaw4zhtmyrrku66pqn9usx4x59h &0/0
102 100000000 389bf4b8c31d5dca7e36cffc361a8a020916cb242015e816ccacfa5312be564c:0
Loading descriptor from wallet default ... success
Wallet total balance: 100000000 ṩ
Import contract for Alice
$ rgb -d .alice import examples/rgb20-simplest.rgb
Importing consignment rgb:csg:D6$4UcFP-6siMEPG-z5WedGG-!gfynub-7vIFN93-KGneAc4#parking-agent-parody:
- validating the contract rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0 ... success
Consignment is imported
After that, we can inspect contracts state with rgb state command.
get the state of the contract for Alice
$ rgb -d .alice contracts
rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0 bitcoin 2024-06-13 rgb:sch:KzMZV9bO7gFhox97!klj0FonG2ZKnjuOIg2tFChu$YA#lucas-episode-silicon
Developer: ssi:anonymous
$ export RGB20_CONTRACT="rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0"note: special characters (such as "$") in RGB20_CONTRACT environment variable will need escaping, i.e.,
$ export RGB20_CONTRACT="rgb:vi09buwx-VuXsvVi-VBA9Htw-sL5Vf81-22oM0V1-pxpGi\$c"
↑ # rgb -d <DATA_DIR> state <CONTRACT_ID> <IFACE>
$ rgb -d .alice state $RGB20_CONTRACT RGB20Fixed
Global:
spec := (ticker=("TEST"), name=("Test asset"), details=~, precision=8)
terms := (text=(""), media=~)
issuedSupply := (100000000000)
Owned:
assetOwner:
value=adMhBHaQ, utxo=bc:tapret1st:311ec7d43f0f33cda5a0c515a737b5e0bbce3896e6eb32e67db0e868a58f4150:1, witness=~Import contract For Bob:
$ rgb -d .bob import examples/rgb20-simplest.rgb
$ rgb -d .bob contracts
$ rgb -d .bob state $RGB20_CONTRACT RGB20Fixed
Global:
spec := (ticker=("TEST"), name=("Test asset"), details=~, precision=8)
terms := (text=(""), media=~)
issuedSupply := (100000000000)
Owned:
assetOwner:Now we have successfully created an rgb20 token, and the owner
is bc:tapret1st:311ec7d43f0f33cda5a0c515a737b5e0bbce3896e6eb32e67db0e868a58f4150:1, which belongs to Alice.
There are about five steps in a complete transfer:
- Create an invoice
- Construct a PSBT
- Make a transfer
- Accept the transfer
- Sign the PSBT and broadcast it
To receive 1,000 #Test, Bob needs to create an invoice and send it to Alice.
$ rgb -d .bob invoice $RGB20_CONTRACT RGB20Fixed 2000
rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0/RGB20Fixed/TadF+bcrt:utxob:4HhkKFP6-92o3r0C-EUCK1DI-k0hamBB-CU9xauX-GhjVSHs-IRESQ$ rgb -d .alice transfer \
rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0/RGB20Fixed/TadF+bcrt:utxob:4HhkKFP6-92o3r0C-EUCK1DI-k0hamBB-CU9xauX-GhjVSHs-IRESQ \
transfer.consignment alice.psbtThe consignment is saved in the transfer.consignment file, and needs to be sent to Bob, who is waiting to accept it.
After receiving the transfer.consignment file, Bob could validate it before accepting.
$ rgb -d .bob validate transfer.consignment
The provided consignment is validBob accepts the consignment:
$ rgb -d .bob accept -f transfer.consignment
Transfer accepted into the stashLet's inspect the psbt file:
$ hal psbt decode --regtest alice.psbt{
"unsigned_tx": {
"txid": "0fd2b9f690428f751aa381c82cadf52b50ced63616802fe0803cb983d5ac3e1a",
"wtxid": "0fd2b9f690428f751aa381c82cadf52b50ced63616802fe0803cb983d5ac3e1a",
"size": 137,
"weight": 548,
"vsize": 137,
"version": 2,
"locktime": 0,
"inputs": [
{
"prevout": "d6afd1233f2c3a7228ae2f07d64b2091db0d66f2e8ef169cf01217617f51b8fb:1",
"txid": "d6afd1233f2c3a7228ae2f07d64b2091db0d66f2e8ef169cf01217617f51b8fb",
"vout": 1,
"script_sig": {
"hex": "",
"asm": ""
},
"sequence": 0,
"witness": null
}
],
"outputs": [
{
"value": 99997600,
"script_pub_key": {
"hex": "51209aa1750ffc777b77b7a5e92202e75980072afbec58d51c5130d5857445c8ab20",
"asm": "OP_PUSHNUM_1 OP_PUSHBYTES_32 9aa1750ffc777b77b7a5e92202e75980072afbec58d51c5130d5857445c8ab20",
"type": "unknown",
"address": "bcrt1pn2sh2rluwaah0da9ay3q9e6esqrj47lvtr23c5fs6kzhg3wg4vsqldfds2"
}
},
{
"value": 2000,
"script_pub_key": {
"hex": "51202925d4a457e5ca1f34a89b93c99a109a330b2a8b1787c6f2acd15bfd67cef02e",
"asm": "OP_PUSHNUM_1 OP_PUSHBYTES_32 2925d4a457e5ca1f34a89b93c99a109a330b2a8b1787c6f2acd15bfd67cef02e",
"type": "unknown",
"address": "bcrt1p9yjaffzhuh9p7d9gnwfunxssngesk25tz7rudu4v69dl6e7w7qhq5x43k5"
}
}
],
"total_output_value": 99999600
},
"inputs": [
{
"witness_utxo": {
"value": 100000000,
"script_pub_key": {
"hex": "51209be0a0f65783a274cc28c4bc5746c38e1e3394913133692ce0ef1b2cf9e8ac2f",
"asm": "OP_PUSHNUM_1 OP_PUSHBYTES_32 9be0a0f65783a274cc28c4bc5746c38e1e3394913133692ce0ef1b2cf9e8ac2f",
"type": "unknown",
"address": "bcrt1pn0s2pajhsw38fnpgcj79w3kr3c0r89y3xyekjt8qaudje70g4shs20nwfx"
}
}
}
],
"outputs": [
{},
{}
]
}Now, it's Alice's turn to sign the PSBT file and broadcast it.
Sign the PSBT with sparrow, hal, or bdk-cli.
After broadcasting, mine 1 block.
cargo run --bin broadcast_tx
cd <bitlight-local-env-public>
make core-cli
mint 1
At that time, Bob and Alice would get different outputs with rgb state and rgb validate.
For Alice:
$ RGB20_CONTRACT="rgb:2TglHDbZ-!ntHfLf-yLEEFpM-o!sLGAz-Bw84b8m-hXRuSW0"
$ rgb -d .alice state $RGB20_CONTRACT RGB20Fixed --sync
Global:
spec := (ticker=("TEST"), name=("Test asset"), details=~, precision=8)
terms := (text=(""), media=~)
issuedSupply := (100000000000)
Owned:
assetOwner:
value=gdFhBHaQ, utxo=bc:tapret1st:2b8a634b6ffeccf1f45626cc02ff53c51a883fad2dee7136f356ed5bdba3d5d5:0, witness=bc:2b8a634b6ffeccf1f45626cc02ff53c51a883fad2dee7136f356ed5bdba3d5d5For Bob:
rgb -d .bob state $RGB20_CONTRACT RGB20Fixed --sync
Global:
spec := (ticker=("TEST"), name=("Test asset"), details=~, precision=8)
terms := (text=(""), media=~)
issuedSupply := (100000000000)
Owned:
assetOwner:
value=TadF, utxo=bc:tapret1st:e7f9ba563995090f00e1e279e63151a9ebdc11747843f6195e1a72391985174e:0, witness=bc:2b8a634b6ffeccf1f45626cc02ff53c51a883fad2dee7136f356ed5bdba3d5d5