{"id":13436588,"url":"https://github.com/nimiq/core-rs","last_synced_at":"2025-03-18T21:30:41.660Z","repository":{"id":45811584,"uuid":"161755659","full_name":"nimiq/core-rs","owner":"nimiq","description":"Official Rust implementation of the Nimiq protocol","archived":true,"fork":false,"pushed_at":"2023-02-24T15:51:23.000Z","size":7163,"stargazers_count":74,"open_issues_count":9,"forks_count":10,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-02-28T04:30:18.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nimiq.com","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nimiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","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":"2018-12-14T08:36:02.000Z","updated_at":"2024-11-14T14:50:02.000Z","dependencies_parsed_at":"2024-10-27T19:14:05.245Z","dependency_job_id":"ecfc63c5-781d-4019-afa5-85d64cfe1aad","html_url":"https://github.com/nimiq/core-rs","commit_stats":{"total_commits":600,"total_committers":17,"mean_commits":"35.294117647058826","dds":0.6516666666666666,"last_synced_commit":"24a91874d50ea052cd7a5e1b603b57bb0596a4f0"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nimiq","download_url":"https://codeload.github.com/nimiq/core-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244310353,"owners_count":20432522,"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","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-07-31T03:00:50.472Z","updated_at":"2025-03-18T21:30:40.726Z","avatar_url":"https://github.com/nimiq.png","language":"Rust","funding_links":[],"categories":["Applications","应用 Applications","Rust","应用","应用程序 Applications"],"sub_categories":["Cryptocurrencies","加密货币 Cryptocurrencies"],"readme":"# Nimiq Core implementation in Rust _(core-rs)_\n\n![nimiq](docs/nimiq_logo_rgb_horizontal.png)\n\n\u003e Rust implementation of the Nimiq Blockchain Core\n\n**[Nimiq](https://nimiq.com/)**  is a frictionless payment protocol for the web.\n\nThis repository is archived. You can use the [JavaScript implementation](https://github.com/nimiq/core-js/) instead.\nOr if you are looking for the [Albatross Rust implementation](https://github.com/nimiq/core-rs-albatross/), check the corresponding repository.\n\nThe Nimiq Rust client comes without wallet and can currently not be used to send transactions. As a back-bone node it is more performant than the JavaScript implementation though.\n\n## Table of Contents\n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Background\n\n- [Nimiq White Paper](https://www.nimiq.com/whitepaper/): General information about the Nimiq project.\n- [Nimiq Developer Reference](https://nimiq-network.github.io/developer-reference/): Details of the protocol architecture.\n\n\n## Install\n\nBesides [Rust nightly](https://www.rust-lang.org/learn/get-started#installing-rust) itself, the following packages are required to be able to compile this source code:\n\n- `gcc`\n- `pkg-config`\n- `libssl-dev` (in Debian/Ubuntu) or `openssl-devel` (in Fedora/Red Hat)\n\n### From crates.io\n\nTo download from [crates.io](https://crates.io), compile and install the client:\n\n```bash\ncargo +nightly install nimiq-client\n```\n\nThe binary will be installed in your Cargo directory, which is usually at `$HOME/.cargo/bin`, and should be available in your `$PATH`.\n\n### From Git\n\nCompiling the project is achieved through [`cargo`](https://doc.rust-lang.org/cargo/):\n\n```bash\ngit clone https://github.com/nimiq/core-rs\ncd core-rs\ncargo +nightly build\n```\n\nNote that this will build it in debug mode, which is not as performant. To get the most speed out of the client, build it in release mode:\n\n```bash\ncargo +nightly build --release\n```\n\nIf you want to install the client onto your system (into `$HOME/.cargo/bin`), run:\n\n```bash\ncargo +nightly install --path client/\n```\n\nAlternatively you can install directly from git:\n\n```bash\ncargo +nightly install --git https://github.com/nimiq/core-rs.git\n```\n\n\nAfter installing the client you can use it as if you had downloaded it from [crates.io](https://crates.io).\n\n## Usage\n\nAfter installation, you can run the client directly, like this:\n\n```bash\nnimiq-client\n```\n\n### Configuration\n\nBy default the client will look for a configuration file in `$HOME/.nimiq/client.config`. You need to create this file yourself:\n\n```bash\nnimiq-client                                                   # Run the client. This will create the example config file.\ncp $HOME/.nimiq/client.example.toml $HOME/.nimiq/client.toml   # Create your config from the example.\nnano $HOME/.nimiq/client.toml                                  # Edit the config. Explanations are included in the file.\n```\n\nYou can also specify your own configuration file:\n\n```bash\nnimiq-client -c path/to/client.toml\n```\n\nTake a look at [`client/client.example.toml`](client/client.example.toml) for all the configuration options.\n\n\n## Contributing\n\nIf you'd like to contribute to the development of Nimiq please follow our [Code of Conduct](/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](/.github/CONTRIBUTING.md).\n\nSmall note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## License\n\nThis project is under the [Apache License 2.0](./LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimiq%2Fcore-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnimiq%2Fcore-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimiq%2Fcore-rs/lists"}