Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvements #11

Merged
merged 4 commits into from
Sep 9, 2022
Merged

Docs improvements #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbe2678
Refactor out install script, can be executed separately.
cryptoquick Aug 22, 2022
f60f3d0
Remove dbc commit step. Add msg argument. Clarify some steps.
cryptoquick Aug 23, 2022
92d9b35
Fix typo
cryptoquick Aug 24, 2022
57396c1
Update install script to use descriptor-wallet 0.8.3.
cryptoquick Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions contrib/demo-rgb.sh
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,8 @@

# --- INITIAL SETUP

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

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

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

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

# --- CONTRACT ISSUANCE

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

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

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

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

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

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

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

Expand Down
19 changes: 19 additions & 0 deletions contrib/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Only nightly cargo supports installing binary bundles
rustup toolchain install nightly
rustup update nightly
# This installs all 4 LNP/BP nodes
cargo install --force --all-features bp_node --version "0.8.0-alpha.2"
cargo install --force --all-features lnp_node --version "0.8.0"
cargo install --force --all-features rgb_node --version "0.8.0"
cargo install --force --all-features storm_node --version "0.8.0"
cargo install --force --all-features store_daemon --version "0.8.0"
# This install --forces a dozen of command-line tools for working with LNP/BP stack
cargo install --force --all-features descriptor-wallet --version "0.8.3"
cargo install --force --all-features bp-core --version "0.8.0"
cargo install --force --all-features rgb-std --version "0.8.0"
cargo install --force --all-features rgb20 --version "0.8.0-rc.4"
cargo install --force --all-features bp-cli --version "0.8.0-alpha.2"
cargo install --force --all-features lnp-cli --version "0.8.0"
cargo install --force --all-features rgb-cli --version "0.8.0"
cargo install --force --all-features storm-cli --version "0.8.0"
cargo install --force --all-features store-cli --version "0.8.0"