`ord`
=====
`ord` is an index, block explorer, and command-line wallet.
Ordinals are serial numbers for satoshis, assigned in the order in which they
are mined, and preserved across transactions.
See [the BIP](bip.mediawiki) for a comprehensive description of the assignment
and transfer algorithm.
See [the project board](https://github.com/users/casey/projects/3/) for
currently prioritized issues.
See [milestones](https://github.com/casey/ord/milestones) to get a sense of
where the project is and where it's going.
Join [the Discord server](https://discord.gg/87cjuz4FYg) to chat with fellow
ordinal degenerates.
Installation
------------
`ord` is written in Rust and can be built from
[source](https://github.com/casey/ord). Pre-built binaries are available on the
[releases page](https://github.com/casey/ord/releases).
You can install the latest pre-built binary from the command line with:
```sh
Once `ord` is installed, you should be able to run `ord --version` on the
command line.
Syncing
-------
`ord` requires a synced `bitcoind` node with `-txindex` to build the index of
ordinal locations. `ord` communicates with `bitcoind` via RPC.
If `bitcoind` is run locally by the same user, without additional
configuration, `ord` should find it automatically by reading the `.cookie` file
from `bitcoind`'s datadir, and connecting using the default RPC port.
If `bitcoind` is not on mainnet, is not run by the same user, has a non-default
datadir, or a non-default port, you'll need to pass additional flags to `ord`.
See `ord --help` for details.
Logging
--------
`ord` uses [env_logger](https://docs.rs/env_logger/latest/env_logger/). Set the
`RUST_LOG` environment variable in order to turn on logging. For example, run
the server and show `info`-level log messages and above:
```
$ RUST_LOG=info cargo run server
```