Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Setheum-Labs/Setheum

Setheum: zk-SNARKs Enabled DAG Powered Blockchain for Light-speed Smart Contracts. Ready for hacking ๐Ÿš€
https://github.com/Setheum-Labs/Setheum

blockchain blockchain-dag contracts cryptocurrency dag defi erc20 evm setheum setheum-network smart smart-contracts solidity substrate

Last synced: 14 days ago
JSON representation

Setheum: zk-SNARKs Enabled DAG Powered Blockchain for Light-speed Smart Contracts. Ready for hacking ๐Ÿš€

Lists

README 

        
ุจูุณู’ู…ู ุงู„ู„ูŽู‘ู‡ู ุงู„ุฑูŽู‘ุญู’ู…ูŽู†ู ุงู„ุฑูŽู‘ุญููŠู…



# Setheum - Powering The New Internet





  




* Decentralized

* Exceptional

* Secure

* Interoperable

* Reliable

* Ethical

* Scalable



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






[![Setheum version](https://img.shields.io/badge/Setheum-0.9.80-blue?logo=Parity%20Substrate)](https://setheum.xyz/)

[![License](https://img.shields.io/github/license/Setheum-Labs/Setheum?color=blue)](https://github.com/Setheum-Labs/Setheum/blob/master/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/contributor/CONTRIBUTING.md)



 



[![Website](https://img.shields.io/badge/web-gray?logo=web)](https://setheum.xyz)

[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FSetheum)](https://twitter.com/Setheum)

[![Telegram](https://img.shields.io/badge/Telegram-gray?logo=telegram)](https://t.me/SetheumNetwork)

[![Medium](https://img.shields.io/badge/Medium-gray?logo=medium)](https://medium.com/setheum-labs)






> NOTE: SETHEUM means `Salam Ethereum`, it also means `The house of gifts` from the name `Seth/Sheeth` meaning `gift` in hebrew and the name of the Prophet Sheeth/Seth in Islam,  it also stands for `Secure, Evergreen, Truthful, Heterogeneous, Economically Unbiased Market`.



- [Setheum - Powering The New Internet](#setheum---powering-the-new-internet)

  - [1.0. Introduction](#10-introduction)

    - [1.1. Setheum Chain](#11-setheum-chain)

    - [1.2. EthicalDeFi](#12-ethicaldefi)

  - [2.0. Getting Started](#20-getting-started)

    - [2.1. Build](#21-build)

    - [2.2. Run](#22-run)

      - [2.2.1. Start a development node](#221-start-a-development-node)

      - [2.2.2. Run a persistent single-node chain](#222-run-a-persistent-single-node-chain)

  - [3.0. Development](#30-development)

  - [4.0. Nodes](#40-nodes)

    - [4.1. Embedded docs](#41-embedded-docs)

    - [4.2. Release builds](#42-release-builds)

    - [4.3. On-Chain upgrade builds](#43-on-chain-upgrade-builds)

  - [5.0. EVM - Generate Tokens \& Predeploy Contracts](#50-evm---generate-tokens--predeploy-contracts)

  - [6.0. Benchmark](#60-benchmark)

    - [6.1. Run Benchmark Tests](#61-run-benchmark-tests)

    - [6.2. Generate Runtime Module Weights Locally](#62-generate-runtime-module-weights-locally)

    - [6.3. Generate Module weights](#63-generate-module-weights)

    - [6.4. Bench Bot](#64-bench-bot)

      - [6.4.1. Generate Module Weights](#641-generate-module-weights)

      - [6.4.2. Generate Runtime Weights](#642-generate-runtime-weights)

  - [7.0. Fork Setheum Chain](#70-fork-setheum-chain)

  - [8.0. Contributing \& Code of Conduct](#80-contributing--code-of-conduct)

  - [9.0. License](#90-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 secure, confidential and interoperable decentralised internet cloud compute and storage blockchain network with EVM and WASM smart contracts,

web3 and web 2 Support. The intent of the Setheum Network is to improve upon Web3 and solve the blockchain trilemma with a mixture of approaches and a recipe

formed from what we have seen and considered to be some of the best solutions in the field, improving on scalability, security, mass adoption, diversity,

and ethics while preserving decentralisation and democratisation.



etheum intends to be the most scalable blockchain network in the world while providing

confidentiality for smart contracts, Cloud Computing and Storage Infrastructure for Web3 based Internet Solutions and Interoperability with both Web2 and

other Web3 Networks. The AlephBFT Consensus Engine powers the Setheum Chain to have near instant finality,

high throughput and high scalability.



Setheumโ€™s consensus system works to achieve high scalability and high security with an ethical and equitably high level of decentralisation.



### 1.2. EthicalDeFi



EthicalDeFi Suite is the DeFi powerhouse of the Setheum Network, providing all kinds of top notch DeFi protocols including a cutting-edge AMM DEX, modules,

Decentralised Liquid Staking for Setheum SE and 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 zero-interest loans of stable cryptocurrencies that has scalable value and trust,

setheum provides just that, backed by crypto assets with efficient zero-interest loans.



## 2.0. Getting Started



This project contains some configuration files to help get started :hammer_and_wrench:



### 2.1. Build



Clone this repository:



```bash

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

```



Install Rust:



```bash

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

```



> If, after installation, running `rustc --version` in the console fails, refer to [it](https://www.rust-lang.org/tools/install) to repair.



You can install developer tools on Ubuntu with:



```bash

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](https://docs.substrate.io/v3/getting-started/installation) for more info.



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



```bash

git config --global submodule.recurse true

```



You can install required tools and git hooks:



```bash

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.



```bash

make run

```



#### 2.2.2. Run a persistent single-node chain



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



```bash

make build

```



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



```bash

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

```



Purge the development chain's state:



```bash

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

```



Start the development chain with detailed logging:



```bash

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

```



## 3.0. Development



Run type check:



```bash

make check-all

```



Run tests:



```bash

make test

```



Run in debugger:



```bash

make debug

```



Purge old chain data:



```bash

make purge

```



Purge old chain data and run:



```bash

make restart

```



Update Cargo:



```bash

make update

```



Update ORML:



```bash

cd orml && git checkout master && git pull

git add orml

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](./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:



```bash

./target/release/setheum-node -h

```



### 4.2. Release builds



To list all available release builds run:



```bash

git tag

```



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



```bash

git checkout testnet-1

```



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



```bash

make release

```



### 4.3. On-Chain upgrade builds



Build the wasm runtime with:



```bash

make wasm

```



## 5.0. EVM - Generate Tokens & Predeploy Contracts



```bash

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:



```bash

make bench

```



Run module benchmark tests:



```bash

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

```



### 6.2. Generate Runtime Module Weights Locally



```bash

make benchmark

```



### 6.3. Generate Module weights



Run the module benchmarks and generate the weights file:



```bash

./target/release/setheum-node benchmark \

    --chain=dev \

    --steps=50 \

    --repeat=20 \

    --pallet=module_currencies \

    --extrinsic='*'  \

    --execution=wasm \

    --wasm-execution=compiled \

    --heap-pages=4096 \

    --output=./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 ` 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 ` 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).



```bash

make chain=testnet fork

```



3) Now run a forked chain:



```bash

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](./CODE_OF_CONDUCT.md).



## 9.0. License



The code in this repository is licensed under the [GNU GPL Version 3 License](./LICENSE.md)



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](./LICENSE.md), without any additional terms or conditions.