{"id":19303816,"url":"https://github.com/web3w/ord","last_synced_at":"2025-08-03T06:07:16.380Z","repository":{"id":232393429,"uuid":"710294667","full_name":"web3w/ord","owner":"web3w","description":"ord wallet","archived":false,"fork":false,"pushed_at":"2023-10-26T12:15:59.000Z","size":5828,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"rich","last_synced_at":"2025-04-13T03:50:09.182Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/web3w.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-26T12:12:06.000Z","updated_at":"2023-10-26T12:17:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"070e53e5-39ed-4119-95a2-bcee871ee683","html_url":"https://github.com/web3w/ord","commit_stats":null,"previous_names":["web3w/ord"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/web3w/ord","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3w%2Ford","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3w%2Ford/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3w%2Ford/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3w%2Ford/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/web3w","download_url":"https://codeload.github.com/web3w/ord/tar.gz/refs/heads/rich","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/web3w%2Ford/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268500608,"owners_count":24260163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T23:27:40.108Z","updated_at":"2025-08-03T06:07:16.337Z","avatar_url":"https://github.com/web3w.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"`ord`\n=====\n\n curl --data-binary '{\"jsonrpc\":\"1.0\",\"id\":\"1\",\"method\":\"getblockcount\",\"params\":[]}' http://test:testpwd@10.58.204.103:8443\n\n --bitcoin-rpc-user test --bitcoin-rpc-pass testpwd  --rpc-url --rpc-url=test:testpwd@10.58.204.103:8443 -r server\n\n  cargo run -r --cookie-file /Users/liyu/Github/ord/ord/src --rpc-url=http://10.58.204.103:8443 server\n\n  /root/bin/ord -r server\n\n`ord` is an index, block explorer, and command-line wallet. It is experimental\nsoftware with no warranty. See [LICENSE](LICENSE) for more details.\n\nOrdinal theory imbues satoshis with numismatic value, allowing them to\nbe collected and traded as curios.\n\nOrdinal numbers are serial numbers for satoshis, assigned in the order in which\nthey are mined, and preserved across transactions.\n\nSee [the docs](https://docs.ordinals.com) for documentation and guides.\n\nSee [the BIP](bip.mediawiki) for a technical description of the assignment and\ntransfer algorithm.\n\nSee [the project board](https://github.com/users/casey/projects/3/) for\ncurrently prioritized issues.\n\nSee [milestones](https://github.com/ordinals/ord/milestones) to get a sense of\nwhere the project is and where it's going.\n\nJoin [the Discord server](https://discord.gg/87cjuz4FYg) to chat with fellow\nordinal degenerates.\n\nDonate\n------\n\nOrdinals is open-source and community funded. The current lead maintainer of\n`ord` is [raphjaph](https://github.com/raphjaph/). Raph's work on `ord` is\nentirely funded by donations. If you can, please consider donating!\n\nThe donation address is\n[bc1qguzk63exy7h5uygg8m2tcenca094a8t464jfyvrmr0s6wkt74wls3zr5m3](https://mempool.space/address/bc1qguzk63exy7h5uygg8m2tcenca094a8t464jfyvrmr0s6wkt74wls3zr5m3).\n\nThis address is 2 of 4 multisig wallet with keys held by\n[raphjaph](https://twitter.com/raphjaph),\n[erin](https://twitter.com/realizingerin),\n[rodarmor](https://twitter.com/rodarmor), and\n[ordinally](https://twitter.com/veryordinally).\n\nBitcoin received will go towards funding maintenance and development of `ord`,\nas well as hosting costs for [ordinals.com](https://ordinals.com).\n\nThank you for donating!\n\nWallet\n------\n\n`ord` relies on Bitcoin Core for private key management and transaction signing.\nThis has a number of implications that you must understand in order to use\n`ord` wallet commands safely:\n\n- Bitcoin Core is not aware of inscriptions and does not perform sat\n  control. Using `bitcoin-cli` commands and RPC calls with `ord` wallets may\n  lead to loss of inscriptions.\n\n- `ord wallet` commands automatically load the `ord` wallet given by the\n  `--wallet` option, which defaults to 'ord'. Keep in mind that after running\n  an `ord wallet` command, an `ord` wallet may be loaded.\n\n- Because `ord` has access to your Bitcoin Core wallets, `ord` should not be\n  used with wallets that contain a material amount of funds. Keep ordinal and\n  cardinal wallets segregated.\n\n### Pre-alpha wallet migration\n\nAlpha `ord` wallets are not compatible with wallets created by previous\nversions of `ord`. To migrate, use `ord wallet send` from the old wallet to\nsend sats and inscriptions to addresses generated by the new wallet with `ord\nwallet receive`.\n\nInstallation\n------------\n\n`ord` is written in Rust and can be built from\n[source](https://github.com/ordinals/ord). Pre-built binaries are available on the\n[releases page](https://github.com/ordinals/ord/releases).\n\nYou can install the latest pre-built binary from the command line with:\n\n```sh\ncurl --proto '=https' --tlsv1.2 -fsLS https://ordinals.com/install.sh | bash -s\n```\n\nOnce `ord` is installed, you should be able to run `ord --version` on the\ncommand line.\n\nBuilding\n--------\n\nOn Debian and Ubuntu, `ord` requires `libssl-dev` when building from source:\n\n```\nsudo apt-get install libssl-dev\n```\n\nYou'll also need Rust:\n\n```\ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n```\n\nTo build `ord` from source:\n\n```\ngit clone https://github.com/ordinals/ord.git\ncd ord\ncargo build --release\n```\n\nOnce built, the `ord` binary can be found at `./target/release/ord`.\n\n`ord` requires `rustc` version 1.67.0 or later. Run `rustc --version` to ensure you have this version. Run `rustup update` to get the latest stable release.\n\nContributing\n------------\n\nIf you wish to contribute there are a couple things that are helpful to know. We\nput a lot of emphasis on proper testing in the code base, with three broad\ncategories of tests: unit, integration and fuzz. Unit tests can usually be found at\nthe bottom of a file in a mod block called `tests`. If you add or modify a\nfunction please also add a corresponding test. Integration tests try to test\nend-to-end functionality by executing a subcommand of the binary. Those can be\nfound in the [tests](tests) directory. We don't have a lot of fuzzing but the\nbasic structure of how we do it can be found in the [fuzz](fuzz) directory.\n\nWe strongly recommend installing [just](https://github.com/casey/just) to make\nrunning the tests easier. To run our CI test suite you would do:\n\n```\njust ci\n```\n\nThis corresponds to the commands:\n\n```\ncargo fmt -- --check\ncargo test --all\ncargo test --all -- --ignored\n```\n\nHave a look at the [justfile](justfile) to see some more helpful recipes\n(commands). Here are a couple more good ones:\n\n```\njust fmt\njust fuzz\njust doc\njust watch ltest --all\n```\n\nIf the tests are failing or hanging, you might need to increase the maximum\nnumber of open files by running `ulimit -n 1024` in your shell before you run\nthe tests, or in your shell configuration.\n\nWe also try to follow a TDD (Test-Driven-Development) approach, which means we\nuse tests as a way to get visibility into the code. Tests have to run fast for that\nreason so that the feedback loop between making a change, running the test and\nseeing the result is small. To facilitate that we created a mocked Bitcoin Core\ninstance in [test-bitcoincore-rpc](./test-bitcoincore-rpc).\n\nSyncing\n-------\n\n`ord` requires a synced `bitcoind` node with `-txindex` to build the index of\nsatoshi locations. `ord` communicates with `bitcoind` via RPC.\n\nIf `bitcoind` is run locally by the same user, without additional\nconfiguration, `ord` should find it automatically by reading the `.cookie` file\nfrom `bitcoind`'s datadir, and connecting using the default RPC port.\n\nIf `bitcoind` is not on mainnet, is not run by the same user, has a non-default\ndatadir, or a non-default port, you'll need to pass additional flags to `ord`.\nSee `ord --help` for details.\n\n`bitcoind` RPC Authentication\n-----------------------------\n\n`ord` makes RPC calls to `bitcoind`, which usually requires a username and\npassword.\n\nBy default, `ord` looks a username and password in the cookie file created by\n`bitcoind`.\n\nThe cookie file path can be configured using `--cookie-file`:\n\n```\nord --cookie-file /path/to/cookie/file server\n```\n\nAlternatively, `ord` can be supplied with a username and password on the\ncommand line:\n\n```\nord --bitcoin-rpc-user foo --bitcoin-rpc-pass bar server\n```\n\nUsing environment variables:\n\n```\nexport ORD_BITCOIN_RPC_USER=foo\nexport ORD_BITCOIN_RPC_PASS=bar\nord server\n```\n\nOr in the config file:\n\n```yaml\nbitcoin_rpc_user: foo\nbitcoin_rpc_pass: bar\n```\n\nLogging\n--------\n\n`ord` uses [env_logger](https://docs.rs/env_logger/latest/env_logger/). Set the\n`RUST_LOG` environment variable in order to turn on logging. For example, run\nthe server and show `info`-level log messages and above:\n\n```\n$ RUST_LOG=info cargo run server\n```\n\nNew Releases\n------------\n\nRelease commit messages use the following template:\n\n```\nRelease x.y.z\n\n- Bump version: x.y.z → x.y.z\n- Update changelog\n- Update dependencies\n- Update database schema version\n```\n\nTranslations\n------------\n\nTo translate [the docs](https://docs.ordinals.com) we use this\n[mdBook i18n helper](https://github.com/google/mdbook-i18n-helpers).\nSo read through their [usage guide](https://github.com/google/mdbook-i18n-helpers/blob/main/USAGE.md)\nto see the structure that translations should follow.\n\nThere are some other things to watch out for but feel free to just start a\ntranslation and open a PR. Have a look at [this commit](https://github.com/ordinals/ord/commit/329f31bf6dac207dad001507dd6f18c87fdef355)\nfor an idea of what to do. A maintainer will also help you integrate it into our\nbuild system.\n\nTo align your translated version of the Handbook with reference to commit\n[#2427](https://github.com/ordinals/ord/pull/2426), here are some guiding\ncommands to assist you. It is assumed that your local environment is already\nwell-configured with [Python](https://www.python.org/),\n[Mdbook](https://github.com/rust-lang/mdBook),\n[mdBook i18n helper](https://github.com/rust-lang/mdbb) and that you've clone\nthis repo.\n\n\n1. Run the following command to generate a new `pot` file, which is named as\n`messages.pot`:\n\n```\nMDBOOK_OUTPUT='{\"xgettext\": {\"pot-file\": \"messages.pot\"}}'\nmdbook build -d po\n```\n\n2. Run `msgmerge` where `xx.po` is your localized language version following\nthe naming standard of [ISO639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).\nThis process will update the `po` file with the most recent original version:\n\n```\nmsgmerge --update po/xx.po po/messages.pot\n```\n\n3. Look for `#, fuzzy`. The `mdBook-i18n-helper` tool utilizes the `\"fuzzy\"` tag\nto highlight sections that have been recently edited. You can proceed to perform\nthe translation tasks by editing the `\"fuzzy\"`part.\n\n4. Execute the `mdbook` command. A demonstration in Chinese (`zh`) is given below:\n\n```\nmdbook build docs -d build\nMDBOOK_BOOK__LANGUAGE=zh mdbook build docs -d build/zh\nmv docs/build/zh/html docs/build/html/zh\npython3 -m http.server --directory docs/build/html --bind 127.0.0.1 8080\n```\n\n5. Upon verifying everything and ensuring all is in order, you can commit the\nmodifications and progress to open a Pull Request (PR) on Github.\n(**Note**: Please ensure **ONLY** the **'xx.po'** file is pushed, other files\nsuch as '.pot' or files ending in '~' are **unnecessary** and should **NOT** be\nincluded in the Pull Request.）\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb3w%2Ford","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweb3w%2Ford","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweb3w%2Ford/lists"}