From 02fdcdbefda830eb7475c9a7c67df182bbf28aaa Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Tue, 22 Nov 2022 12:22:11 -0800 Subject: [PATCH 1/2] Add minimum system requirements to readme --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 56502539bb..f359eb79f0 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,11 @@ 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/casey/ord/projects/1) for currently -prioritized issues. +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. @@ -116,6 +119,18 @@ 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. +### Minimum System Requirements + +Building the `ord` index is memory-intensive. An `ord` instance running on a +reasonably powerful system with 64 GiB of RAM and a fully-synced, +locally-hosted Bitcoin Core node can build the index in under 24 hours. + +An `ord` instance running on a system with less than 64 GiB of RAM will take +much longer to build the index, with reports of + +A this point in development, the format of the `ord` index is changing rapidly, +so be prepared to delete and re-sync the index. + ### 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: From d6c3c9872ad3d6d61d0fd937f5ae801769b93f08 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Tue, 22 Nov 2022 13:53:48 -0800 Subject: [PATCH 2/2] tweak --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f359eb79f0..254d1f4b5d 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,8 @@ reasonably powerful system with 64 GiB of RAM and a fully-synced, locally-hosted Bitcoin Core node can build the index in under 24 hours. An `ord` instance running on a system with less than 64 GiB of RAM will take -much longer to build the index, with reports of +much longer to build the index, with some users reporting sync times of two +weeks or more. A this point in development, the format of the `ord` index is changing rapidly, so be prepared to delete and re-sync the index.