app

README

CoreStarIO RandApp

CoreStarIO RandApp is Cosmos-based SDK, designed for easier building blockchain applications using on-chain DKG algorithm in Golang.

More about cosmos-sdk.

Notable source code files to check out about DKG:

1. https://github.com/corestario/tendermint/blob/dcr-random/types/random.go
2. https://github.com/corestario/tendermint/blob/dcr-random/consensus/dkg.go
3. https://github.com/corestario/tendermint/blob/dcr-random/consensus/dkg_dealer.go

On-chain DKG works the same way as the off-chain version but writes its messages to blocks, which allows us to slash a validator that refuses to participate in a DKG round.

More about DKG and lib, which implements corresponding algorithm see dkglib.

Running a local-testnet

Ensure that you have docker!

Ensure that dkglib folder is next to your randapp folder!

It is necessary for building docker images and starting testnet!

Example:

/ home

**/ projects

****/ randapp

****/ dkglib

Run from randapp folder:

./testnet.sh

You might need to run it as superuser.

Flags:

      -h, --help                    show brief help
      -n, --node_count=n            specify node count
      --no_rebuild                  run without rebuilding docker images
      --kill                        stop and remove testnet containers; remove additional files
      --restart                     removes testnet and starts it without rebuild; equals --kill && --no_rebuild
      --ruin                        force stop containers 1 and 2 after 5 seconds running dkg
      --logs                        save current logs to local ./logs folder
      -l, --log n [r|d]             print log from container with number n in console; r for randapp, d for dkglib logs

Application logs are stored in docker container in /root/ folder.

randapp - /root/rd_start.log

dkglib - /root/dkglib.log

Running a node

To build and run a node with a script:

./run.sh

Step by step run

(Re)build and (re)install node and client:

rm -rf ~/.r*
rm $GOPATH/bin/rcli
rm $GOPATH/bin/rd
make install

Initialize configuration files and genesis file:

rd init --chain-id [chain_id]

Add validator:

rcli keys add [validator_name]:

Add both accounts, with coins to the genesis file:

rd add-genesis-account $(rcli keys show [validator_name] -a) 1000nametoken,100000000stake

Configure your CLI to eliminate need for chain-id flag:

rcli config chain-id [chain_id]
rcli config output json
rcli config indent true
rcli config trust-node true

Start the node:

chmod +w ~/.rd/config
rd start

Documentation

Index

• Variables
• func MakeCodec() *codec.Codec
• func NewRandApp(logger log.Logger, db dbm.DB) *randApp
• func ReadSrvConfig() *config.RAServerConfig
• type GenesisState
  • func NewDefaultGenesisState() GenesisState

Variables

var (
	// default home directories for the application CLI
	DefaultCLIHome = os.ExpandEnv("$HOME/../rcli")

	// DefaultNodeHome sets the folder where the applcation data and configuration will be stored
	DefaultNodeHome = os.ExpandEnv("$HOME/")

	// ModuleBasicManager is in charge of setting up basic module elemnets
	ModuleBasics = module.NewBasicManager(
		genutil.AppModuleBasic{},
		auth.AppModuleBasic{},
		bank.AppModuleBasic{},
		params.AppModuleBasic{},
		staking.AppModuleBasic{},
		distr.AppModuleBasic{},
		slashing.AppModuleBasic{},
		supply.AppModuleBasic{},

		randapp.AppModule{},
	)
)

Functions

func MakeCodec

func MakeCodec() *codec.Codec

MakeCodec generates the necessary codecs for Amino

func NewRandApp

func NewRandApp(logger log.Logger, db dbm.DB) *randApp

NewRandApp is a constructor function for randApp.

func ReadSrvConfig

func ReadSrvConfig() *config.RAServerConfig

Types

type GenesisState

type GenesisState map[string]json.RawMessage

GenesisState represents chain state at the start of the chain. Any initial state (account balances) are stored here.

func NewDefaultGenesisState

func NewDefaultGenesisState() GenesisState