From a70ac805346e3b2eaf2f7c4c4d1b97e7db8a4ea2 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Fri, 13 Jan 2023 12:35:23 -0800 Subject: [PATCH] Add warnings to readme --- README.md | 19 ++++++++++++++++++- src/options.rs | 2 +- tests/wallet/create.rs | 2 +- 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 387e5d46f0..a3856c713a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ `ord` ===== -`ord` is an index, block explorer, and command-line wallet. +`ord` is an index, block explorer, and command-line wallet. It is experimental +software with no warranty. See [LICENSE](LICENSE) for more details. Ordinal theory imbues satoshis with numismatic value, allowing them to collected and traded as curios. @@ -23,6 +24,22 @@ where the project is and where it's going. Join [the Discord server](https://discord.gg/87cjuz4FYg) to chat with fellow ordinal degenerates. +Wallet +------ + +`ord` wallets rely on Bitcoin Core for private key management and transaction +signing, so `ord` wallet commands interact with Bitcoin Core wallets. `ord` +should not be used in the presence of wallets that contain a material amount +of funds. Using `bitcoin-cli` commands and RPC calls with `ord` wallets may +lead to loss of sats and inscriptions. + +### Pre-alpha wallet migration + +Alpha `ord` wallets are not compatible with wallets created by previous +versions of `ord`. To migrate, use `ord wallet send` from the old wallet to +send sats and inscriptions to addresses generated by the new wallet with `ord +wallet receive`. + Installation ------------ diff --git a/src/options.rs b/src/options.rs index 095f9ef6ec..67e69ce8cc 100644 --- a/src/options.rs +++ b/src/options.rs @@ -181,7 +181,7 @@ impl Options { .count(); if tr != 2 || descriptors.len() != 2 + rawtr { - bail!("this does not appear to be an ord wallet, create one with `ord wallet create`"); + bail!("wallet \"{}\" contains unexpected output descriptors, and does not appear to be an `ord` wallet, create a new wallet with `ord wallet create`", self.wallet); } } diff --git a/tests/wallet/create.rs b/tests/wallet/create.rs index 7cc3b03296..14be27684e 100644 --- a/tests/wallet/create.rs +++ b/tests/wallet/create.rs @@ -66,7 +66,7 @@ fn detect_wrong_descriptors() { CommandBuilder::new("wallet transactions") .rpc_server(&rpc_server) .stderr_regex( - "error: this does not appear to be an ord wallet, create one with `ord wallet create`\n", + r#"error: wallet "ord" contains unexpected output descriptors, and does not appear to be an `ord` wallet, create a new wallet with `ord wallet create`\n"#, ) .expected_exit_code(1) .run();