Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to reflect wallet changes #3179

Merged
merged 9 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion batch.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# example batch file

# inscription modes:
# - `same-sat`: inscribe on the same sat
# - `satpoints`: inscribe on the first sat of specified satpoint's output
# - `separate-outputs`: inscribe on separate postage-sized outputs
# - `shared-output`: inscribe on a single output separated by postage
# - `same-sat`: inscribe on the same sat
mode: separate-outputs

# parent inscription:
Expand Down
158 changes: 79 additions & 79 deletions docs/po/ar.po

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Summary
- [Donate](donate.md)
- [Guides](guides.md)
- [Explorer](guides/explorer.md)
- [Inscriptions](guides/inscriptions.md)
- [Wallet](guides/wallet.md)
- [Batch Inscribing](guides/batch-inscribing.md)
- [Sat Hunting](guides/sat-hunting.md)
- [Teleburning](guides/teleburning.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/guides/collecting/sparrow-wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ This UTXO (Inscription) is now un-spendable within the Sparrow Wallet until you

## Importing into `ord` wallet

For details on setting up Bitcoin Core and the `ord` wallet check out the [Inscriptions Guide](../inscriptions.md)
For details on setting up Bitcoin Core and the `ord` wallet check out the [Wallet Guide](../wallet.md)

When setting up `ord`, instead of running `ord wallet create` to create a brand-new wallet, you can import your existing wallet using `ord wallet restore "BIP39 SEED PHRASE"` using the seed phrase you generated with Sparrow Wallet.

Expand Down
7 changes: 5 additions & 2 deletions docs/src/guides/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@ Ordinal Explorer
================

The `ord` binary includes a block explorer. We host an instance of the block
explorer on mainnet at [ordinals.com](https://ordinals.com), and on signet at
[signet.ordinals.com](https://signet.ordinals.com).
explorer on mainnet at [ordinals.com](https://ordinals.com), on signet at
[signet.ordinals.com](https://signet.ordinals.com), and on testnet at
[testnet.ordinals.com](https://testnet.ordinals.com). As of version 0.16.0 the
wallet needs `ord server` running in the background. This is analogous to how
`bitcoin-cli` needs `bitcoind` running in the background.

### Running The Explorer
The server can be run locally with:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/guides/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Testing
Ord can be tested using the following flags to specify the test network. For more
information on running Bitcoin Core for testing, see [Bitcoin's developer documentation](https://developer.bitcoin.org/examples/testing.html).

Most `ord` commands in [inscriptions](inscriptions.md) and [explorer](explorer.md)
Most `ord` commands in [wallet](wallet.md) and [explorer](explorer.md)
can be run with the following network flags:

| Network | Flag |
Expand Down
39 changes: 31 additions & 8 deletions docs/src/guides/inscriptions.md → docs/src/guides/wallet.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Ordinal Inscription Guide
=========================
Wallet
======

Individual sats can be inscribed with arbitrary content, creating
Bitcoin-native digital artifacts that can be held in a Bitcoin wallet and
Expand Down Expand Up @@ -158,18 +158,41 @@ ord --version

Which prints out `ord`'s version number.

Creating a Bitcoin Core Wallet
------------------------------
Creating a Wallet
-----------------

`ord` uses `bitcoind` to manage private keys, sign transactions, and
broadcast transactions to the Bitcoin network. Additionally the `ord wallet`
requires [`ord server`](explorer.md) running in the background. Make sure these
programs are running:

```
bitcoind -txindex
```

`ord` uses Bitcoin Core to manage private keys, sign transactions, and
broadcast transactions to the Bitcoin network.
```
ord server
```

To create a Bitcoin Core wallet named `ord` for use with `ord`, run:
To create a wallet named `ord`, the default, for use with `ord wallet`, run:

```
ord wallet create
```

If you want to specify a different name or use an `ord server` running on a
non-default URL you can set these options:

```
ord wallet --name foo --server-url http://127.0.0.1:8080 create
```

To see all available wallet options you can run:

```
ord wallet help
```

Receiving Sats
--------------

Expand Down Expand Up @@ -301,7 +324,7 @@ ord wallet receive
The sender can transfer the inscription to your address using:

```
ord wallet send ADDRESS INSCRIPTION_ID
ord wallet send --fee-rate <FEE_RATE> ADDRESS INSCRIPTION_ID
```

See the pending transaction with:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For more details on ordinal theory, see the [overview](overview.md).
For more details on inscriptions, see [inscriptions](inscriptions.md).

When you're ready to get your hands dirty, a good place to start is with
[inscriptions](guides/inscriptions.md), a curious species of digital artifact
[inscriptions](guides/wallet.md), a curious species of digital artifact
enabled by ordinal theory.

Links
Expand Down
Loading