Skip to content

Commit

Permalink
Add warning to readme (ordinals#1213)
Browse files Browse the repository at this point in the history
  • Loading branch information
casey committed Jan 16, 2023
1 parent 9a8e9f1 commit 782605e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 3 deletions.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -23,6 +24,32 @@ 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` relies on Bitcoin Core for private key managment and transaction signing.
This has a number of implications that you must understand in order to use
`ord` wallet commands safely:

- Bitcoin Core does is not aware of inscriptions and does not perform sat
control. Using `bitcoin-cli` commands and RPC calls with `ord` wallets may
lead to loss of inscriptions.

- `ord wallet` commands automatically load the `ord` wallet given by the
`--wallet` option, which defaults to 'ord'. Keep in mind that after running
an `ord wallet` command, an `ord` wallet may be loaded.

- Because `ord` has access to your Bitcoin Core wallets, `ord` should not be
used with wallets that contain a material amount of funds. Keep ordinal and
cardinal wallets segregated.

### 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
------------

Expand Down
2 changes: 1 addition & 1 deletion src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}

Expand Down
2 changes: 1 addition & 1 deletion tests/wallet/create.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,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();
Expand Down

0 comments on commit 782605e

Please sign in to comment.