seeleteamslashgo-seele-sub

README

Go-Seele-Sub (Stem)

Seele subchain (beta version) was officially released on March 29, 2020. Seele Stem aims to provide a full set of useful features while preserving the safety of the funds in the child chain. It supports account-based child chains, safe and flexible deposit/exit operations, fast access to the account balance in the Stem smart contract, customizable state finality of the child chain. The Seele Stem subchain aims at increasing Seele mainnet's capacity and manifesting diversified and abundant applications. For more details, please see Seele Stem subchain protocol. So far, Practical Byzantine Fault Tolerance (PBFT) is used as consensus protocol.

Download (without building)

If you want to directly run the node and use client without setting up the compiling enviroment and building the executable files, you can choose right version to download and run:

Operation System	Download Link
Linux	[https://github.com/seeleteam/go-seele-sub/releases]
MacOs	[https://github.com/seeleteam/go-seele-sub/releases]
Windows	[https://github.com/seeleteam/go-seele-sub/releases]

Or Download & Build the source

Building the Seele project requires both a Go (version 1.7 or later) compiler and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

• Building the Seele project requires both a Go (version 1.7 or later) compiler and a C compiler. Install Go v1.10 or higher, Git, and the C compiler.

• Clone the go-seele-sub repository to the GOPATH directory:

go get -u -v github.com/seeleteam/go-seele-sub/...

• Change the cloned folder name from "go-seele-sub" to "go-seele"

• Once successfully cloned code and rename the folder:

cd GOPATH/src/github.com/seeleteam/go-seele/

• Linux & Mac

make all

• Windows

buildall.bat

How to Start Subchain

• Creat A Subchain (Creator)

  1. Create A Subchain Smart Contract and Deploy on Seele MainNet. Pleae refer to SubChain Smart Contract
  2. Releaes and Anounce(for example, mall_pay_template)

• Run Subchain (Operators & Normal Users)

  1. For running a subchain node, please refer to Subchain Start Guide

  2. User controller middleware to operate subchain:

     • (Operations: Relay/Deposit/Challenge/Exit/...), please refer to Controller User Guide
     • Controller Test Guide
     • Controller Configuration

For more usage details and deeper explanations, please go to Seele Subchain Introduction and Seele Wiki(Older version).

Contribution

Thank you for considering helping out with our source code. We appreciate any contributions, even the smallest fixes.

Here are some guidelines before you start:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Pull requests need to be based on and opened against the master branch.
• We use reviewable.io as our review tool for any pull request. Please submit and follow up on your comments in this tool. After you submit a PR, there will be a Reviewable button in your PR. Click this button, it will take you to the review page (it may ask you to login).
• If you have any questions, feel free to join chat room to communicate with our core team.

License

go-seele/LICENSE