Skip to content

Commit

Permalink
Update README.md - Add TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
@balqaasem
balqaasem committed Feb 11, 2024
1 parent 6c730b0 commit b83e383
Showing 1 changed file with 46 additions and 48 deletions.
94 changes: 46 additions & 48 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,39 @@ Setheum's Blockchain Network node Implementation in Rust, ready for hacking :roc

</div>

<!-- TOC -->

- [1. Introduction](#1-introduction)
- [2. Setheum](#2-Setheum)
- [2.1. bnbnbn](#21-jhjk)
- [2.2. hhjhj](#22-tghhgjh)
- [3. Building](#3-building)
- [4. Run](#4-run)
- [5. Development](#5-development)
- [6. Bug Bounty :bug:](#6-bug-bounty-bug)
> 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`.
<!-- TOC -->
- [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)
<!-- /TOC -->

## 1. Introduction
## 1.0. Introduction

> 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`.
### 1.1 Setheum
### 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,
Expand All @@ -66,19 +81,19 @@ 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
### 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. Getting Started
## 2.0. Getting Started

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

### 2.1 Build
### 2.1. Build

Clone this repository:

Expand Down Expand Up @@ -124,15 +139,15 @@ make build-full

### 2.2. Run

#### 2.2.1 Start a development node
#### 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
#### 2.2.2. Run a persistent single-node chain

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

Expand All @@ -158,7 +173,7 @@ Start the development chain with detailed logging:
RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/setheum-node -lruntime=debug --dev
```

## 3. Development
## 3.0. Development

Run type check:

Expand Down Expand Up @@ -220,19 +235,19 @@ 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. Nodes
## 4.0. Nodes

For Docs on running nodes, check [./docs/nodes.md](./docs/nodes.md)

### 4.1 Embedded docs
### 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
### 4.2. Release builds

To list all available release builds run:

Expand All @@ -252,23 +267,23 @@ Then run this command to install appropriate compiler version and produce a bina
make release
```

### 4.3 On-Chain upgrade builds
### 4.3. On-Chain upgrade builds

Build the wasm runtime with:

```bash
make wasm
```

## 5. EVM - Generate Tokens & Predeploy Contracts
## 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. Benchmark
## 6.0. Benchmark

### 6.1. Run Benchmark Tests

Expand Down Expand Up @@ -323,7 +338,7 @@ Comment on a PR `/bench runtime module <module_name>` i.e.: `/bench runtime modu

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

## 5. Fork Setheum Chain
## 7.0. Fork Setheum Chain

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

Expand All @@ -341,32 +356,15 @@ cd fork/data
./binary --chain fork.json --alice
```

## 6. Contributing & Code of Conduct
## 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).

## 7. Licenses

The code in this repository is licensed as follows:

1. [Apache-2.0](.LICENSES/Apache-2.0.md)
2. [GPL3](.LICENSES/GPL3.md)
3. [MIT](.LICENSES/MIT.md)

### 7.1 [Apache-2.0 License](.LICENSES/Apache-2.0.md) / [MIT License](.LICENSES/MIT.md)

All crates under [/highend](./highend) directory are licensed under the terms of the [Apache-2.0 License](.LICENSES/Apache-2.0.md) and or the [MIT License](.LICENSES/MIT.md).

* Apache-2.0 License
* MIT License

Unless you explicitly state otherwise, any contribution that you submit to this directory shall be dual licensed as above (as defined in the [Apache-2.0 License](.LICENSES/Apache-2.0.md) and or the [MIT License](.LICENSES/MIT.md)), without any additional terms or conditions.

### 7.2 [GPL-3 License](.LICENSES/GPL3.md)
## 9.0. License

All rest are licensed under either of the following licenses, at your discretion.
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 (outside of the [./highend](./highend) directory) shall be licensed as above (as defined in the [GNU GPL-3 Version 3.0 or later](.LICENSES/GPL3.md) WITH Classpath exception 2.0, without any additional terms or conditions.
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.

0 comments on commit b83e383

Please sign in to comment.