stratos-chain

README

Stratos-Chain

Stratos is the first decentralized data architecture that provides scalable, reliable, self-balanced storage, database and computation network, and offers a solid foundation for data processing. Stratos-Chain is a Golang implementation of the Stratos protocol.

---

Building the source

Prerequisites:

• Go 1.15+
• git
• wget

Platform:

• Linux(tested on Ubuntu18.04)

First, make a directory(e.g., stratos) and directly download the source

mkdir stratos
cd stratos
git clone https://github.com/stratosnet/stratos-chain.git
cd stratos-chain
git checkout v0.5.0  # you may need to change to the latest version.
make build

• Mac OS

mkdir stratos
cd stratos
git clone https://github.com/stratosnet/stratos-chain.git
cd stratos-chain
git checkout v0.5.0  # you may need to change to the latest version.
make build-mac

After make build or make build-mac, you will find the stchaind and stchaincli binary files in stratos/stratos-chain/build.

The build directory is your working directory, and you can continue your operations inside this folder.

Your working directory looks like

     .
     ├── config
     ├── data
     ├── stchaincli
     └── stchaind

The config folder

     .
     ├── addrbook.json
     ├── app.toml
     ├── config.toml
     ├── genesis.json
     ├── node_key.json
     └── priv_validator_key.json

In config folder:

addrbook.json stores peer addresses.

app.toml contains the default settings required for app.

config.toml contains various options pertaining to the stratos-chain configurations.

genesis.json defines the initial state upon genesis of stratos-chain.

node_key.json contains the node private key and should thus be kept secret.

priv_validator_key.json contains the validator address, public key and private key, and should thus be kept secret.

---

Executables

The Stratos-Chain comes with 2 types of executables that can be found in stratos/stratos-chain/build directory.

Command	Description
stchaincli	the client end. It is the command line interface for interacting with stchaind. It is the entry point into the Stratos network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Stratos network via JSON RPC endpoints.
stchaind	the app Daemon (server)

stchaincli

Usage:
  stchaincli [command]

Available Commands:
  status      Query remote node for status
  config      Create or query an application CLI configuration file
  query       Querying subcommands
  tx          Transactions subcommands
  rest-server Start LCD (light-client daemon), a local REST server
  keys        Add or view local private keys
  version     Print the app version
  help        Help about any command

Each stchaincli command may contain a set of flags or parameters. for more details, please refer to Stratos-chain 'stchaincli' Commands

stchaind

Usage:
  stchaind [command]

Available Commands:
  init                Initialize private validator, p2p, genesis, and application configuration files
  collect-gentxs      Collect genesis txs and output a genesis.json file
  migrate             Migrate genesis to a specified target version
  gentx               Generate a genesis tx carrying a self delegation
  validate-genesis    validates the genesis file at the default location or at the location passed as an arg
  add-genesis-account Add a genesis account to genesis.json
  faucet              Run a faucet cmd
  debug               Tool for helping with debugging your application
  start               Run the full node
  unsafe-reset-all    Resets the blockchain database, removes address book files, and resets priv_validator.json to the genesis state
  tendermint          Tendermint subcommands
  export              Export state to JSON
  version             Print the app version
  help                Help about any command

Each stchaind command may contain a set of flags or parameters. for more details, please refer to Stratos-chain 'stchaind' Commands

---

Connect to Stratos Network

Going through all the possible command line flags is out of scope here, but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own Stratos instance.

A Full node on the test Stratos network

For prerequisites and detailed instructions of connecting to test network, please read the Connect to TestNet.

Full node on the main Stratos network - TBA

Prerequisites and detailed instructions of main network will be added later.

---

Documents

We published all the documents here

---

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to stratos-chain, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.

Please make sure your contributions adhere to our coding guidelines:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.
• Pull requests need to be based on and opened against the main branch.
• Commit messages should be prefixed with the package(s) they modify.
  • E.g. "eth, rpc: make trace configs optional"

---

License

Copyright 2021 Stratos

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.