# Ord Client

### Prerequisite <a href="#prerequisite" id="prerequisite"></a>

Make sure you setup your Bitcoin Node and it has finished syncing before you setup the Ord Client

If you haven't completed the prerequisite, use the following link to complete those steps first.

### Ord Setup (Mac) <a href="#ord-setup-mac" id="ord-setup-mac"></a>

```
ord --help

ord wallet -help

ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet balance
```

### [Other Commands](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#other-commands) <a href="#other-commands" id="other-commands"></a>

> Reference: [Hell Money Podcast: How to Make an Inscription Part 2](https://www.youtube.com/watch?v=LXrUu8WOrHo)

10. Transfer the new Ordinal to a keeper wallet as desired. For the safety afforded with its coin-control features, this is most easily done from Sparrow after you import your Ord wallet using the seed phrase. And if after importing the Ord wallet into Sparrow, Sparrow does not reveal your inscription, try changing Sparrow's Gap Limit setting (Wallet > Advanced > Gap Limit) from the default to something like 250. This setting tells Sparrow how many empty address to find before it stops scanning them for transactions.

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet inscriptions
```

9. To see your inscriptions

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet inscribe /Users/yourusername/Desktop/OrdinalsTest.txt --destination bc1addresstoreceivetheinscription1234 --fee-rate 35 --dry-run
```

> Note: To do a dry run (perhaps to see the total cost before actually broadcasting the transaction)

6. Wait for the commit and reveal transactions to complete
7. Note your inscription ID is shown in the output. You can paste that into Ordinals.com or your Ord page to view the inscription
8. The inscription is sent to a new address in your Ord wallet

> This test is to create a text-based Ordinal with the contents of OrdinalsTest.txt as the body of the Ordinal. For a higher fee you can instead inscribe anything (ex. .webp file, which is an ideally compressed image).

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet inscribe /Users/yourusername/Desktop/OrdinalsTest.txt --fee-rate 35
```

5. Inscribe while setting the fee rate to an appropriate level as can found on [mempool.space](https://mempool.space/)

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet balance
```

2. Send BTC to this address as will be need to pay inscription transaction fees assessed by the network.
3. Ord will play a sound when the payment transaction is confirmed. Wait for Bitcoin QT to show the updated available balance. Or go to [mempool.space](https://mempool.space/) and paste the address to see the status of the transaction.
4. Confirm the wallet balance

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet receive
```

1. To get a fresh address

#### [Create an Inscription](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#create-an-inscription) <a href="#create-an-inscription" id="create-an-inscription"></a>

2. Temporarily paste the seed phrase so that you can later save it as desired (ex. print it to hardcopy and lock it in your safe)

> Note: Add ‘ | pbcopy’ to the end of the command if you want the resulting seed phrase to automatically be copied to the clipboard

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie wallet create | pbcopy
```

1. Kill the Ord server with CTRL-C

#### [Create the Wallet](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#create-the-wallet) <a href="#create-the-wallet" id="create-the-wallet"></a>

Inscription services make it very easy to inscribe anything. However, for more advanced inscription needs such as inscribing on an Uncommon sat you are holding, you may need to inscribe from your Ord server. The following steps provide the basic foundation for inscribing from Ord.

### [Create an Ord Wallet & Inscribe](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#create-an-ord-wallet--inscribe) <a href="#create-an-ord-wallet--inscribe" id="create-an-ord-wallet--inscribe"></a>

> Reference: [Hell Money Podcast: How to Make an Inscription Part 1](https://www.youtube.com/watch?v=zXlvkOSVM9M\&t=1s)

> Congratulations. Bitcoin Core and Ord are fully installed and functioning. You always need Bitcoin running before starting Ord. And at any time, you can use CTRL-C to stop the Ord server and restart it.

2. In the browser go to <http://localhost> to access your local host of Ordinals.com

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie server
```

1. Start Ord Server

> Note: Ord indexes automatically while running the Ord Server. So the index function (not shown below) is only used as a means to index when not running server.

> Important: You will want to routinely backup your Ord index file as it will become corrupted at times. When that occurs (as is indicated when the Ord server starts throwing up errors) you simply delete the index.redb file and replace it with your latest backup. Ord will then rebuild the index from where it left off.

1. Before starting Ord Server, create a backup of the ord index in case file ever gets corrupted

### [Start the Ord Server](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#start-the-ord-server) <a href="#start-the-ord-server" id="start-the-ord-server"></a>

7. Wait as long as it takes for the index build to complete
8. In Terminal, use CTRL-C at any point to stop the process (it can be restarted later)

```
ord --index /Volumes/Bitcoin/Ord/index.redb --cookie-file /Volumes/Bitcoin/Bitcoin/.cookie index
```

> Note: If you did not move the Ord index from its standard location, you do not need the --index argument

4. On the external drive, create a folder called 'Ord'
5. In the new folder, add a plain text empty file called ‘index.redb’
   1. Or [download an index file](https://45.128.27.75/) as linked from a posting in [The Ordicord Discord server](https://discord.com/channels/987504378242007100/1083363982963908640) and place this as your starting index file
6. Start building the index with the following command where the additional arguments are required to point to the external hard drive location of the index.redb and cookie.index files

> The default location for the Ord index is ‘/Users/yourusername/Library/Application Support/ord’ but in this setup it will be created on an external drive. For performance reasons, an SSD drive is recommended. SSD is not explicitly required of course, but with it you will see dramatic speed improvement during indexing and the increased performance will reduce the number events resulting in a corrupt index file.

2. Save and close the bitcoin.conf file
3. Restart Bitcoin Core

```
server=1
```

1. In the bitcoin.conf file add the following entry

### [Build the Ord Index](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#build-the-ord-index) <a href="#build-the-ord-index" id="build-the-ord-index"></a>

> Note for reference: The Ord binary is stored in /Users/yourusername/.cargo/bin

```
ord --version
```

3. Once Ord is installed, the following command should reveal that Ord is installed by indicating its location. Alternately you can use the command 'which ord'

```
cargo install ord
```

1. Start your Bitcoin node (Open Bitcoin QT from your Applications folder)
2. In terminal, enter the install command

### [Install Ord](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#install-ord) <a href="#install-ord" id="install-ord"></a>

5. Close Terminal and reopen it

```
which cargo
```

4. Try again to confirm Terminal now finds Cargo

```
source "$HOME/.cargo/env"
```

```
which cargo
```

1. Go to <https://rustup.rs> and copy the command and paste it to run in Terminal
2. Where you are presented an option and one is shown with “(default)”, just press enter at the prompt to use that default
3. Add Cargo to the path
   1. If the following command returns "cargo not found", that confirms Cargo is not already in the shell. Then proceed to next command (source...)

Ord is written in Rust. RustUp installs the required Rust language and Cargo package manager. Commands below are to be used in Terminal.

### [Install Cargo with RustUp](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#install-cargo-with-rustup) <a href="#install-cargo-with-rustup" id="install-cargo-with-rustup"></a>

The method chosen below uses Cargo to install Ord.

```
curl --proto '=https' --tlsv1.2 -fsLS https://ordinals.com/install.sh | bash -s
```

Cargo presents a simple method for installing Ord. While we did not try this, instead of using Cargo you may be able to install the latest pre-built binary from Terminal with the following command.

[<br>](https://mattonchain.github.io/notes-on-a-chain/ord-setup.html#ord-setup-mac)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://8bit-1.gitbook.io/send-nodes/ord-client.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
