From 2cf4448798db8c181624cbab807eb024d31d32d7 Mon Sep 17 00:00:00 2001 From: Chris Guida Date: Wed, 29 May 2024 13:11:15 -0600 Subject: [PATCH] Clean up README Add warning about Lampo forgetting the seed on restart Also fix some typos in log messages --- README.md | 29 ++++++++++++++++++----------- lampo-bdk-wallet/src/lib.rs | 2 +- lampod-cli/src/main.rs | 4 ++-- 3 files changed, 21 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9af12a7a..b4a838e4 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Crates -These are the complete list of crates supported right now: +This is the complete list of crates supported right now: | Crate | Description | Version | |:------------|:---------------------------------------------:|------------:| @@ -24,27 +24,34 @@ These are the complete list of crates supported right now: ## How to Install -To install all the requirements binary we need to -have rust installed, and then run the following command +To install all the requirements and the Lampo binary, you need to +have rust installed, and then run the following command: ``` make install ``` -After you have `lampod-cli` and `lampo-cli` available and the following -commands can be ran +After you have `lampod-cli` and `lampo-cli` available, you can +run the following command to launch Lampo in signet mode: ``` ➜ ~ lampod-cli --network signet -✓ Wallet Generated, please store this works in a safe way - waller-keys maple have fitness decide food joy flame coast stereo front grab stumble +✓ Wallet Generated, please store these words in a safe way + wallet-keys maple have fitness decide food joy flame coast stereo front grab stumble ``` -N.B: Store your wallet works, and then reuse them to restore the waller with `--restore-wallet`. +>[!NOTE] +Store your wallet words, and then reuse them to restore the wallet with `--restore-wallet`. +If you do not store your words anywhere, your funds will be lost the next time Lampo starts! -Please note that this need to have a `lampo.conf` in the path `~/.lampo/signet`. See an example in lampo.example.conf +Please note that you need to have a `lampo.conf` in the path `~/.lampo/signet`. Run the +following command to use the example config file: -Then you can query the node with the following command +``` +cp lampo.example.conf ~/.lampo/signet/lampo.conf +``` + +Then you can query the node with the following command: ``` ➜ ~ lampo-cli --network signet getinfo @@ -59,7 +66,7 @@ Then you can query the node with the following command Make sure you have compiled core-lightning in developer mode. The installation guide can be found [here](https://docs.corelightning.org/docs/installation). -Integration tests can be run using the following command +Integration tests can be run using the following command: ``` make integration diff --git a/lampo-bdk-wallet/src/lib.rs b/lampo-bdk-wallet/src/lib.rs index 28284ef1..dcc5133b 100644 --- a/lampo-bdk-wallet/src/lib.rs +++ b/lampo-bdk-wallet/src/lib.rs @@ -114,7 +114,7 @@ impl WalletManager for BDKWalletManager { .map_err(|err| bdk::Error::Generic(format!("{:?}", err)))?; // Convert mnemonic to string let mnemonic_words = mnemonic.to_string(); - log::info!("mnemonic works `{mnemonic_words}`"); + log::info!("mnemonic words `{mnemonic_words}`"); let (wallet, keymanager) = BDKWalletManager::build_wallet(conf.clone(), &mnemonic_words)?; Ok(( Self { diff --git a/lampod-cli/src/main.rs b/lampod-cli/src/main.rs index 809fc897..be5156ee 100644 --- a/lampod-cli/src/main.rs +++ b/lampod-cli/src/main.rs @@ -109,9 +109,9 @@ fn run(args: LampoCliArgs) -> error::Result<()> { } }; - radicle_term::success!("Wallet Generated, please store this works in a safe way"); + radicle_term::success!("Wallet Generated, please store these words in a safe way"); radicle_term::println( - radicle_term::format::badge_primary("waller-keys"), + radicle_term::format::badge_primary("wallet-keys"), format!("{}", radicle_term::format::highlight(mnemonic)), ); wallet