nectar/README.md at ef0425a328e481dd1c52d5989b109f92a573d881

mirror of https://github.com/uqbar-dao/nectar.git synced 2024-12-23 16:43:24 +03:00

realisation e7e77d881f included submodule init instructions in README, passing ws ip and port info to register frontend and included new register submodule commit supporting that via classic register flow

2023-10-12 10:38:29 -04:00

2.3 KiB

Raw Blame History

Last updated: 10/02/23

Setup

Building components

# Clone the repo.

git clone git@github.com:uqbar-dao/uqbar.git

# Get some stuff so we can build wasm.

cargo install wasm-tools
rustup install nightly
rustup target add wasm32-wasi
rustup target add wasm32-wasi --toolchain nightly
cargo install cargo-wasi
cargo install --git https://github.com/bytecodealliance/cargo-component --locked cargo-component

# Initialize submodules, in particular the register app
git submodule update --init --recursive

# Build the runtime, along with a number of booted-at-startup WASM modules including terminal and key_value
# OPTIONAL: --release flag
cargo +nightly build --release

# Create the home directory for your node
# If you boot multiple nodes, make sure each has their own home directory.
mkdir home

Boot

If you do not receive QNS updates in terminal, it's a sign that the default public-access RPC endpoint is rate-limiting or blocking you. Get an eth-sepolia-rpc API key and pass that as an argument. You can get one for free at alchemy.com.

Also, make sure not to use the same home directory for two nodes at once! You can use any name for the home directory.

cargo +nightly run --release home --rpc wss://eth-sepolia.g.alchemy.com/v2/<your-api-key>

On boot you will be prompted to navigate to localhost:8080. Make sure your eth wallet is connected to the Sepolia test network. Login should be very straightforward, just submit the transactions and follow the flow.

Terminal syntax

CTRL+C or CTRL+D to shutdown node
CTRL+V to toggle verbose mode, which is on by default
CTRL+J to toggle debug mode
CTRL+S to step through events in debug mode
CTRL+A to jump to beginning of input
CTRL+E to jump to end of input
UpArrow/DownArrow or CTRL+P/CTRL+N to move up and down through command history
CTRL+R to search history, CTRL+R again to toggle through search results, CTRL+G to cancel search
!message <name> <app> <json>: send a card with a JSON value to another node or yourself. can be our, which will be interpreted as our node's username.
!hi <name> <string>: send a text message to another node's command line.
<name> is either the name of a node or our, which will fill in the present node name
more to come

Example usage

TODO