Skip to content

Commit 2d06070

Browse files
authored
Merge pull request #11 from cryptoquick/docs-fixes
Docs improvements
2 parents f4c16ef + 57396c1 commit 2d06070

File tree

2 files changed

+37
-14
lines changed

2 files changed

+37
-14
lines changed

contrib/demo-rgb.sh

100644100755
+18-14
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,8 @@
22

33
# --- INITIAL SETUP
44

5-
# Only nightly cargo supports installing binary bundles
6-
rustup add nigtly
7-
rustup update nigtly
8-
# This installs all 4 LNP/BP nodes at onc
9-
cargo +nightly -Z bindeps install lnpbp_nodes --version 0.8.0-rc.1
10-
# This installs a dozen of command-line tools for working with LNP/BP stack
11-
cargo +nightly -Z bindeps install lnpbp-cli --version 0.8.0-rc.1
5+
# Run separate install script
6+
./install.sh
127

138
DIR=~/.demo # Replace with the desired location
149

@@ -27,11 +22,18 @@ btc-cold check ${WALLET}
2722
# Note the transaction outputs and save them to these variables
2823
UTXO_ISSUE="<txid>:<vout>"
2924
UTXO_CHANGE="<txid>:<vout>"
25+
# Find your wallet's testnet xprv (it's in black text for dark theme terminal users)
26+
btc-hot -P info ${DIR}/testnet.seed
27+
# Initialize lnpd with your hot wallet xprv
28+
lnpd -vvv --network testnet init
3029

3130
tmux new-session -d -s store stored -vvv
3231
tmux new-session -d -s lnp lnpd -vvv --network testnet
3332
tmux new-session -d -s rgb rgbd -vvv --network testnet
34-
tmux new-session -d -s storm storm -vvv --chat --downpour
33+
tmux new-session -d -s storm stormd -vvv --chat --downpour --msg ~/.lnp_node/testnet/msg
34+
# -OR- run all the daemons within the same terminal (processes must be exited using process manager)
35+
# Note: Try all these commands separately first to ensure they can run
36+
stored -vvv & lnpd -vvv --network testnet & rgbd -vvv --network testnet & stormd -vvv --chat --downpour --msg ~/.lnp_node/testnet/msg &
3537

3638
# --- CONTRACT ISSUANCE
3739

@@ -49,10 +51,8 @@ rgb-cli -n testnet contract state ${CONTRACT_ID}
4951
# ----------------------------------------------------------
5052
# Go to a remote server / other machine and do the following
5153

52-
rustup add nigtly
53-
rustup update nigtly
54-
cargo +nightly -Z bindeps install lnpbp_nodes --version 0.8.0-rc.1
55-
cargo +nightly -Z bindeps install lnpbp-cli --version 0.8.0-rc.1
54+
# Run separate install script
55+
./install.sh
5656

5757
DIR=~/.demo # Replace with the desired location
5858

@@ -67,6 +67,10 @@ btc-cold address ${DIR}/testnet2.wallet
6767
btc-cold check ${DIR}/testnet2.wallet
6868
# Note the first transaction output and save it to variable
6969
UTXO="<txid>:<vout>"
70+
# Find your wallet's testnet xprv (it's in black text for dark theme terminal users)
71+
btc-hot -P info ${DIR}/testnet.seed
72+
# Initialize lnpd with your hot wallet xprv
73+
lnpd -vvv --network testnet init
7074

7175
tmux new-session -d -s store stored -vvv
7276
tmux new-session -d -s lnp lnpd -vvv --network testnet --listen-all --bifrost
@@ -136,7 +140,8 @@ rgb psbt analyze ${PSBT}
136140
# data, the txid of the witness transaction is final.
137141
# Now we can finalize the consignment by adding the anchor information to it
138142
# referencing this txid.
139-
# We also instruct the daemon to send the consignment to the beneficiaty LN node.
143+
# We also instruct the daemon to send the consignment to the beneficiary LN node.
144+
# If done on the same system (a self-payment), the --send argument can be omitted.
140145
rgb-cli -n testnet transfer finalize --endseal ${TXOB} ${PSBT} ${CONSIGNMENT} --send
141146

142147
# Those who interested can look into the transfer consignment
@@ -148,7 +153,6 @@ rgb consignment inspect ${CONSIGNMENT}
148153
rgb consignment validate ${CONSIGNMENT}
149154

150155
# Lets finalize, sign & publish the witness transaction
151-
dbc commit ${PSBT}
152156
btc-hot sign ${PSBT} ${DIR}/testnet
153157
btc-cold finalize --publish testnet ${PSBT}
154158

contrib/install.sh

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Only nightly cargo supports installing binary bundles
2+
rustup toolchain install nightly
3+
rustup update nightly
4+
# This installs all 4 LNP/BP nodes
5+
cargo install --force --all-features bp_node --version "0.8.0-alpha.2"
6+
cargo install --force --all-features lnp_node --version "0.8.0"
7+
cargo install --force --all-features rgb_node --version "0.8.0"
8+
cargo install --force --all-features storm_node --version "0.8.0"
9+
cargo install --force --all-features store_daemon --version "0.8.0"
10+
# This install --forces a dozen of command-line tools for working with LNP/BP stack
11+
cargo install --force --all-features descriptor-wallet --version "0.8.3"
12+
cargo install --force --all-features bp-core --version "0.8.0"
13+
cargo install --force --all-features rgb-std --version "0.8.0"
14+
cargo install --force --all-features rgb20 --version "0.8.0-rc.4"
15+
cargo install --force --all-features bp-cli --version "0.8.0-alpha.2"
16+
cargo install --force --all-features lnp-cli --version "0.8.0"
17+
cargo install --force --all-features rgb-cli --version "0.8.0"
18+
cargo install --force --all-features storm-cli --version "0.8.0"
19+
cargo install --force --all-features store-cli --version "0.8.0"

0 commit comments

Comments
 (0)