بِسْمِ اللَّهِ الرَّحْمَنِ الرَّحِيم

Setheum - Powering Light-Speed Web3 Solutions

• Decentralized
• Exceptional
• Secure
• Interoperable
• Reliable
• Ethical
• Scalable

Setheum's Blockchain Network node Implementation in Rust, ready for hacking 🚀

NOTE: SETHEUM means Salam Eth, Super Eth, The house of gifts and gifted. Originally from the name Seth/Sheeth mixed with Ethereum, it also stands for Secure, Evergreen, Truthful, Heterogeneous, Economically Unbiased Market.

• Setheum - Powering The New Internet
  • 1.0. Introduction
    • 1.1. Setheum Chain
    • 1.2. Ethical DeFi
      • 1.2.1. Ethical DeFi Projects
  • 2.0. Getting Started
    • 2.1. Build
    • 2.2. Run
      • 2.2.1. Start a development node
      • 2.2.2. Run a persistent single-node chain
  • 3.0. Development
  • 4.0. Nodes
    • 4.1. Embedded docs
    • 4.2. Release builds
    • 4.3. On-Chain upgrade builds
  • 5.0. EVM - Generate Tokens & Predeploy Contracts
  • 6.0. Benchmark
    • 6.1. Run Benchmark Tests
    • 6.2. Generate Runtime Module Weights Locally
    • 6.3. Generate Module weights
    • 6.4. Bench Bot
      • 6.4.1. Generate Module Weights
      • 6.4.2. Generate Runtime Weights
  • 7.0. Fork Setheum Chain
  • 8.0. Contributing & Code of Conduct
    • 8.1. ToDo List
  • 9.0. License

1.0. Introduction

1.1. Setheum Chain

Founded November 2019,Setheum achieves a high level of equilibrium in the trilemma by leveraging a Directed Acyclic Graph(DAG) to build the blockchain consensus - making it a Blockchain via DAG, achieve instant finality, high throughput and very fast blocktime while preserving network security and having a fairly decentralised network,

Setheum is a light-speed decentralised blockchain network with EVM and WASM smart contracts, built from a mixture of what we have seen and considered to be some of the best solutions in the industry, improving on scalability, security, user experience, ethics,decentralisation and democratisation. Setheum intends to be the most complete blockchain network in the world. The AlephBFT Consensus Engine powers the Setheum Chain to have near instant finality, high throughput and high scalability and high security.

1.2. Ethical DeFi

Ethical DeFi Suite is the DeFi powerhouse of the Setheum Network, providing all kinds of top notch DeFi protocols including an AMM DEX (inspired by Uniswap v3), Ethical Zero-interest Halal Stablecoins that gives us the properties of both Fiat and Crypto with SlickUSD (USSD) and the Setter (SETR) using an Ethical Collateralized Debt Position (ECDP) mechanism that is over-Collateralized and multi-Collateralised and stable without compromising decentralisation or economic stability, offering stable cryptocurrencies that have scalable value and reliability, setheum provides just that, backed by crypto assets on an efficient zero-interest debt-based system.

1.2.1. Ethical DeFi Projects:

• Edfis: Ethical DeFi Suite
  • Edfis Pay: Decentralised Escrow Payment Protocol
  • Edfis Swap Exchange: AMM (Automated Market Maker) DEX Protocol inspired by Uniswap v3 design
  • Edfis P2P Exchange: Decentralized P2P Exchange Protocol as a crypto on-off ramp
  • Edfis Launchpad: Launchpad Crowdsales protocol for bootstrapping pools on Edfis Exchange
  • Edfis Launchpool: Launchpool protocol for bootstrapping pools on Edfis Exchange
• Setter: Unpegged ECDP Stablecoin
• SlickUSD: USD Pegged ECDP Stablecoin

Edfis Pay - Transfers

Create these measures as a part of Edfis Pay so that users can opt-in and out at will.

1. ensure_account_exists(): If the account doesn't exist, fail the transaction.
2. ensure-account_has_ed(): If the account doesn't have ED, fail the transaction.

Provide various types of transfer options to users, each of which must handle both ensure_account_exists() and account_has_ed() options (they are optional for users to use, so they should be of type Boolean).

Transfer Types that Handle this issue:

1. red_packet_transfer: to automatically_unlock the funds to the sender if the receiver does not opened the red packet within TransferUnlockPeriod , therefore reversing the transaction.
2. reclaimable_transfer: allows the sender to reclaim (unlock) the funds if the receiver does not claim the transfer within TransferUnlockPeriod , therefore reversing the transaction.
3. willing_transfer: allows the receiver to accept or reject the funds.
4. reversible_willing_transfer: allows the receiver to accept or reject the funds. The transfer will automatically unlock if the receiver does not claim the transfer within TransferUnlockPeriod , therefore reversing the transaction.
5. protected_transfer: allows the receiver to claim the transfer only if the receiver knows the password to the transfer, else the transfer cannot be claimed therefore the TransferStatus stays as Unclaimed.
6. reversible_protected_transfer: allows the receiver to claim the transfer only if the receiver knows the password to the transfer, else the transfer cannot be claimed. The transfer will automatically_unlock the funds to the sender if the receiver does not claim the transfer within TransferUnlockPeriod.

2.0. Getting Started

This project contains some configuration files to help get started 🛠️

2.1. Build

Clone this repository:

git clone --recursive https://github.com/Setheum-Labs/Setheum

Install Rust:

curl https://sh.rustup.rs -sSf | sh

If, after installation, running rustc --version in the console fails, refer to it to repair.

You can install developer tools on Ubuntu with:

sudo apt-get install -y git make clang curl pkg-config libssl-dev llvm libudev-dev protobuf-compiler build-essential

You may need additional dependencies, checkout substrate.io for more info.

Make sure you have submodule.recurse set to true to ease submodule use.

git config --global submodule.recurse true

You can install required tools and git hooks:

make init

2.2. Run

2.2.1. Start a development node

The make run command will launch a temporary node and its state will be discarded after you terminate the process.

make run

2.2.2. Run a persistent single-node chain

Use the following command to build the node without launching it:

make build

This command will start the single-node development chain with persistent state:

./target/release/setheum-node --dev

Purge the development chain's state:

./target/release/setheum-node purge-chain --dev

Start the development chain with detailed logging:

RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/setheum-node -lruntime=debug --dev

3.0. Development

Run type check:

make check-all

Run tests:

make test

Run in debugger:

make debug

Purge old chain data:

make purge

Purge old chain data and run:

make restart

Update Cargo:

make update

Update ORML:

cd orml && git checkout master && git pull
git add .
cargo update check-all

Update Sygma:

cd sygma && git checkout master && git pull
git add .
cargo update check-all

Note: All build command from Makefile are designed for local development purposes and hence have SKIP_WASM_BUILD enabled to speed up build time and use --execution native to only run using native execution mode.

4.0. Nodes

For Docs on running nodes, check ./docs/nodes.md

4.1. Embedded docs

Once the project has been built, the following command can be used to explore all parameters and subcommands:

./target/release/setheum-node -h

4.2. Release builds

To list all available release builds run:

git tag

To create a corresponding production build, first checkout the tag:

git checkout testnet-1

Then run this command to install appropriate compiler version and produce a binary.

make release

4.3. On-Chain upgrade builds

Build the wasm runtime with:

make wasm

5.0. EVM - Generate Tokens & Predeploy Contracts

make generate-tokens

Note: All build commands with SKIP_WASM_BUILD are designed for local development purposes and hence have the SKIP_WASM_BUILD enabled to speed up build time and use --execution native to only run use native execution mode.

6.0. Benchmark

6.1. Run Benchmark Tests

Run runtime benchmark tests:

make bench

Run module benchmark tests:

cargo test -p module-poc --all-features

6.2. Generate Runtime Module Weights Locally

make benchmark

6.3. Generate Module weights

Run the module benchmarks and generate the weights file:

./target/release/setheum-node benchmark \
    --chain=dev \
    --steps=50 \
    --repeat=20 \
    --pallet=module_currencies \
    --extrinsic='*'  \
    --execution=wasm \
    --wasm-execution=compiled \
    --heap-pages=4096 \
    --output=./blockchain/modules/currencies/src/weights.rs

6.4. Bench Bot

Bench bot can take care of syncing branch with master and generating WeightInfos for module or runtime.

6.4.1. Generate Module Weights

Comment on a PR /bench module <module_name> i.e.: /bench module module_prices

Bench bot will do the benchmarking, generate weights.rs file push and changes into your branch.

6.4.2. Generate Runtime Weights

Comment on a PR /bench runtime module <module_name> i.e.: /bench runtime module module_prices

Bench bot will do the benchmarking, generate weights.rs file and push changes into your branch.

7.0. Fork Setheum Chain

You can create a fork of a live chain (testnet / mainnet) for development purposes.

1. Build binary and sync with target chain on localhost defaults. You will need to use unsafe rpc.
2. Execute the Make command ensuring to specify chain name (testnet / mainnet).

make chain=testnet fork

3. Now run a forked chain:

cd fork/data
./binary --chain fork.json --alice

8.0. Contributing & Code of Conduct

If you would like to contribute, please fork the repository, introduce your changes and submit a pull request. All pull requests are warmly welcome.

In every interaction and contribution, this project adheres to the Contributor Covenant Code of Conduct.

8.1. ToDo List

Note> Before adding/removing a TODO, please carefully read the TODO.md file

Whenever you write a TODO in any file, please add a reference to it here. Whenever you remove a TODO in any file, please remove its reference from here.

9.0. License

The code in this repository is licensed under the GNU GPL Version 3 License

Unless you explicitly state otherwise, any contribution that you submit to this repo shall be licensed as above (as defined in the GNU GPL-3 Version 3.0 or later WITH Classpath-exception-2.0), without any additional terms or conditions.