{"id":13746700,"url":"https://github.com/crustio/crust","last_synced_at":"2025-05-15T17:03:23.970Z","repository":{"id":37098332,"uuid":"232014927","full_name":"crustio/crust","owner":"crustio","description":"Official Rust implementation of the Crust protocol ","archived":false,"fork":false,"pushed_at":"2024-10-29T12:07:40.000Z","size":37164,"stargazers_count":505,"open_issues_count":77,"forks_count":40,"subscribers_count":16,"default_branch":"mainnet","last_synced_at":"2024-10-29T16:31:12.101Z","etag":null,"topics":["crust","decentralized-storage","dsm","gpos","mpow","polkadot","substrate"],"latest_commit_sha":null,"homepage":"https://crust.network","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crustio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-06T03:13:58.000Z","updated_at":"2024-10-29T12:07:43.000Z","dependencies_parsed_at":"2023-10-14T18:02:43.111Z","dependency_job_id":"e92cf8b0-e2ca-4be8-a7df-050935a0458a","html_url":"https://github.com/crustio/crust","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crustio%2Fcrust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crustio%2Fcrust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crustio%2Fcrust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crustio%2Fcrust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crustio","download_url":"https://codeload.github.com/crustio/crust/tar.gz/refs/heads/mainnet","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247737788,"owners_count":20987721,"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":["crust","decentralized-storage","dsm","gpos","mpow","polkadot","substrate"],"created_at":"2024-08-03T06:00:58.959Z","updated_at":"2025-04-07T22:07:40.524Z","avatar_url":"https://github.com/crustio.png","language":"Rust","funding_links":[],"categories":["Web 3.0"],"sub_categories":[],"readme":"# Crust \u0026middot; [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fcrustio%2Fcrust%2Fbadge\u0026style=flat)](https://github.com/crustio/crust/actions?query=workflow%3A%22Crust+CI%22) [![Substrate version](https://img.shields.io/badge/Substrate-3.0.0-blue?logo=Parity%20Substrate)](https://substrate.dev/) [![GitHub license](https://img.shields.io/github/license/crustio/crust?logo=apache)](LICENSE)\n\n\u003ca href='https://web3.foundation/'\u003e\u003cimg width='160' alt='Funded by web3 foundation' src='docs/img/web3f_grants_badge.png'\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href='https://builders.parity.io/'\u003e\u003cimg width='180' src='docs/img/sbp_grants_badge.png'\u003e\u003c/a\u003e\n\nImplementation of a [Crust Protocol](https://crust.network) node with [substrate](https://github.com/paritytech/substrate).\n\n## 🎮 Join to Play\n\nPlease go to [crust wiki](https://wiki.crust.network/docs/en/nodeOverview), refer the node overview.\n\n## Building\n\n### ⌨️ Build from source\n\n#### 1. Install rust\n\n\u003e If, after installation, running `rustc --version` in the console fails, refer to [it](https://www.rust-lang.org/tools/install) to repair.\n\n```shell\ncurl https://sh.rustup.rs -sSf | sh\n```\n\n#### 2. Initialize your wasm build environment\n\n```shell\n./scripts/init.sh\n```\n\n#### 3. Build wasm and native code\n\n```bash\ncargo build --release\n```\n\n#### *4. Troubleshooting\n\n\u003e Depending on different building environments, if you cannot build the source code, please check the detail error message and try to run the corresponding commands to fix it\n\n- Debian/Ubuntu/Raspbian\n\n```shell\nsudo apt install gcc-multilib\n\nwget https://apt.llvm.org/llvm.sh\nchmod +x ./llvm.sh\nsudo ./llvm.sh 10\nsudo ln -s /usr/lib/llvm-10/bin/llvm-config /user/bin/llvm-config\n\nsudo apt install gcc\nsudo apt install clang\n```\n\n- Fedora/RedHat/CentOS\n\n```shell\nsudo yum -y install gcc\nsudo yum -y install clang\n```\n\nAlso, you can join [discord](https://discord.gg/D97GGQndmx) to get help\n\n### 🐳 Dockerize\n\nPlease refer [this](https://github.com/crustio/crust/tree/mainnet/docker#dockerize-crust) to see how to build and run crust with docker.\n\n## ⛰ Live Network\n\n### 1. Connect to mainnet\n\n\u003e The default branch `mainnet` can be build and connect to mainnet.\n\n```shell\n./target/release/crust --chain mainnet\n```\n\nTo speed up the synchronization process, please add the following parameters.\n\n```shell\n--execution=wasm --wasm-execution=compiled\n```\n\n### 2. Connect to maxwell\n\n\u003e Please checkout the branch `release/0.11.1`, then build and connect to maxwell\n\n```shell\n./target/release/crust --chain maxwell\n```\n\nGet the bootnodes from [here](https://raw.githubusercontent.com/crustio/crust/maxwell/node/res/maxwell.json).\n\n## 🍕 Dev Network\n\n### 1. Connect to rocky\n\n\u003e Rocky has the same function and parameters with Mainnet, developers can deploy applications on this free test network. Read [more](https://wiki.crust.network/docs/en/buildRockyGuidance) about rocky.\n\n```shell\n./target/release/crust --chain rocky\n```\n\n### 2. Run as dev\n\nPurge any existing developer chain state:\n\n```bash\n./target/release/crust purge-chain --dev\n```\n\nStart a development chain with:\n\n```bash\n./target/release/crust --dev\n```\n\nDetailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.\n\n### 3. Run as local\n\nIf you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units.\n\nYou'll need two terminal windows open.\n\nWe'll start Alice's substrate node first on default TCP port `30333` with her chain database stored locally at `/tmp/alice`. The bootnode ID of her node is `12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp`, which is generated from the `--node-key` value that we specify below:\n\n```bash\n./target/release/crust \\\n  --base-path /tmp/alice \\\n  --chain local \\\n  --alice \\\n  --node-key 0000000000000000000000000000000000000000000000000000000000000001\n```\n\nIn the second terminal, we'll start Bob's substrate node on a different TCP port of `30334`, and with his chain database stored locally at `/tmp/bob`. We'll specify a value for the `--bootnodes` option that will connect his node to Alice's bootnode ID on TCP port 30333:\n\n```bash\n./target/release/crust \\\n  --base-path /tmp/bob \\\n  --chain local \\\n  --bob \\\n  --port 30334 \\\n  --bootnodes /ip4/127.0.0.1/tcp/30333/p2p/12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp\n```\n\nAdditional CLI usage options are available and may be shown by running `cargo run -- --help`.\n\n## 🙋🏻‍♂️ Contribution\n\nPlease follow the contributions guidelines as outlined in [docs/CONTRIBUTION.md](https://github.com/crustio/crust/blob/master/docs/CONTRIBUTION.md). In all communications and contributions, this project follows the [Contributor Covenant Code of Conduct](https://github.com/paritytech/substrate/blob/master/docs/CODE_OF_CONDUCT.md).\n\n## License\n\n[Apache 2.0](https://github.com/crustio/crust/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrustio%2Fcrust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrustio%2Fcrust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrustio%2Fcrust/lists"}