Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
Add warning about Lampo forgetting the seed on restart
Also fix some typos in log messages
  • Loading branch information
chrisguida authored and vincenzopalazzo committed May 30, 2024
1 parent b4adf2c commit a973f15
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 14 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|:------------|:---------------------------------------------:|------------:|
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lampo-bdk-wallet/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions lampod-cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a973f15

Please sign in to comment.