https://github.com/cardinal-cryptography/aleph-node
Node implementation for aleph blockchain built with Substrate framework
https://github.com/cardinal-cryptography/aleph-node
zero-knowledge
Last synced: about 2 months ago
JSON representation
Node implementation for aleph blockchain built with Substrate framework
- Host: GitHub
- URL: https://github.com/cardinal-cryptography/aleph-node
- Owner: Cardinal-Cryptography
- License: apache-2.0
- Created: 2021-01-20T13:23:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T12:13:28.000Z (3 months ago)
- Last Synced: 2025-05-15T23:02:52.823Z (about 2 months ago)
- Topics: zero-knowledge
- Language: Rust
- Size: 82.4 MB
- Stars: 82
- Watchers: 9
- Forks: 61
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![LOGO][aleph-logo]][aleph-homepage]
This repository contains the Rust implementation of [Aleph Zero][aleph-homepage] blockchain node based on the [Substrate][substrate-homepage] framework.
Aleph Zero is an open-source layer 1 blockchain focused on privacy, scalability and energy efficiency. It is based on a unique, peer-reviewed consensus algorithm, AlephBFT (as described in our [paper][aleph-bft-paper] and implemented [here][aleph-bft-link]).
Aleph node is based on a Substrate node where the default finality gadget (GRANDPA) has been replaced with AlephBFT. Block authoring is realized with Substrate's Aura. The chain is run in periodic sesssions (900 blocks each) utilizing the Session pallet. The authorities in each session serve for both Aura and AlephBFT authorities, and on top of that are responsible for running the Aggregator protocol producing multisignatures of finalized blocks.
### Building
Please consult the [BUILD][build] guide.
### Running
#### Connect to Aleph Zero Testnet
You can connect to global Aleph Zero Testnet network by running `aleph-node --chain=testnet`.
#### Local Network
To experiment with Aleph Node you can locally run a small blockchain network using the [scripts/run_nodes.sh](scripts/run_nodes.sh) script from the root of this repository. Please consult the script or the output of `scripts/run_nodes.sh -help` for additional parameters (like the number of nodes etc.). The script starts multiple instances of Aleph Node on your local machine, so please adjust the number of nodes carefully with performance of your system in mind. By default 4 nodes are started.
You can interact with your locally running nodes using their RPC servers. A more convenient alternative is to attach to it with a polkadot.js wallet app. We recommend using our fork of that app which can be found [here][aleph-polkadot-link].
### Contributing
If you would like to contribute, please fork the repository, introduce your changes and submit a pull request. All pull requests are warmly welcome.
### License
The code in this repository is licensed as follows:
- all crates under `bin` directory are licensed under the terms of the GNU GPL version 3
- all rest of the crates are licensed under the terms of Apache License 2.0.
[aleph-homepage]: https://alephzero.org
[aleph-logo]: https://assets.alephzero.org/branding/logo/digital/A0-horizontal-light-background.jpg
[aleph-bft-link]: https://github.com/Cardinal-Cryptography/AlephBFT
[aleph-bft-paper]: https://arxiv.org/abs/1908.05156
[aleph-polkadot-link]: https://github.com/Cardinal-Cryptography/apps
[substrate-homepage]: https://substrate.io
[build]: ./BUILD.md