Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crustio/crust
Official Rust implementation of the Crust protocol
https://github.com/crustio/crust
crust decentralized-storage dsm gpos mpow polkadot substrate
Last synced: about 16 hours ago
JSON representation
Official Rust implementation of the Crust protocol
- Host: GitHub
- URL: https://github.com/crustio/crust
- Owner: crustio
- License: apache-2.0
- Created: 2020-01-06T03:13:58.000Z (about 5 years ago)
- Default Branch: mainnet
- Last Pushed: 2024-10-29T12:07:40.000Z (3 months ago)
- Last Synced: 2024-10-29T16:31:12.101Z (2 months ago)
- Topics: crust, decentralized-storage, dsm, gpos, mpow, polkadot, substrate
- Language: Rust
- Homepage: https://crust.network
- Size: 35.4 MB
- Stars: 505
- Watchers: 16
- Forks: 40
- Open Issues: 77
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- best-of-crypto - GitHub - 22% open · ⏱️ 05.06.2024): (Web 3.0)
README
# Crust · [](https://github.com/crustio/crust/actions?query=workflow%3A%22Crust+CI%22) [](https://substrate.dev/) [](LICENSE)
Implementation of a [Crust Protocol](https://crust.network) node with [substrate](https://github.com/paritytech/substrate).
## 🎮 Join to Play
Please go to [crust wiki](https://wiki.crust.network/docs/en/nodeOverview), refer the node overview.
## Building
### ⌨️ Build from source
#### 1. Install rust
> If, after installation, running `rustc --version` in the console fails, refer to [it](https://www.rust-lang.org/tools/install) to repair.
```shell
curl https://sh.rustup.rs -sSf | sh
```
#### 2. Initialize your wasm build environment
```shell
./scripts/init.sh
```
#### 3. Build wasm and native code
```bash
cargo build --release
```
#### *4. Troubleshooting
> 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
- Debian/Ubuntu/Raspbian
```shell
sudo apt install gcc-multilib
wget https://apt.llvm.org/llvm.sh
chmod +x ./llvm.sh
sudo ./llvm.sh 10
sudo ln -s /usr/lib/llvm-10/bin/llvm-config /user/bin/llvm-config
sudo apt install gcc
sudo apt install clang
```
- Fedora/RedHat/CentOS
```shell
sudo yum -y install gcc
sudo yum -y install clang
```
Also, you can join [discord](https://discord.gg/D97GGQndmx) to get help
### 🐳 Dockerize
Please refer [this](https://github.com/crustio/crust/tree/mainnet/docker#dockerize-crust) to see how to build and run crust with docker.
## ⛰ Live Network
### 1. Connect to mainnet
> The default branch `mainnet` can be build and connect to mainnet.
```shell
./target/release/crust --chain mainnet
```
To speed up the synchronization process, please add the following parameters.
```shell
--execution=wasm --wasm-execution=compiled
```
### 2. Connect to maxwell
> Please checkout the branch `release/0.11.1`, then build and connect to maxwell
```shell
./target/release/crust --chain maxwell
```
Get the bootnodes from [here](https://raw.githubusercontent.com/crustio/crust/maxwell/node/res/maxwell.json).
## 🍕 Dev Network
### 1. Connect to rocky
> 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.
```shell
./target/release/crust --chain rocky
```
### 2. Run as dev
Purge any existing developer chain state:
```bash
./target/release/crust purge-chain --dev
```
Start a development chain with:
```bash
./target/release/crust --dev
```
Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.
### 3. Run as local
If 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.
You'll need two terminal windows open.
We'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:
```bash
./target/release/crust \
--base-path /tmp/alice \
--chain local \
--alice \
--node-key 0000000000000000000000000000000000000000000000000000000000000001
```
In 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:
```bash
./target/release/crust \
--base-path /tmp/bob \
--chain local \
--bob \
--port 30334 \
--bootnodes /ip4/127.0.0.1/tcp/30333/p2p/12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp
```
Additional CLI usage options are available and may be shown by running `cargo run -- --help`.
## 🙋🏻♂️ Contribution
Please 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).
## License
[Apache 2.0](https://github.com/crustio/crust/blob/master/LICENSE)