genesis

Documentation

Index

• type Account
  • func (a *Account) InitBalances() ([]address.Address, []*big.Int)
• type Blockchain
• type Delegate
• type Genesis
  • func New() (Genesis, error)
• type Poll
• type Rewarding
  • func (r *Rewarding) BlockReward() *big.Int
  • func (r *Rewarding) EpochReward() *big.Int
  • func (r *Rewarding) InitAdminAddr() address.Address
  • func (r *Rewarding) InitBalance() *big.Int

Types

type Account

type Account struct {
	// InitBalanceMap is the address and initial balance mapping before the first block.
	InitBalanceMap map[string]string `yaml:"initBalances"`
}

Account contains the configs for account protocol

func (*Account) InitBalances

func (a *Account) InitBalances() ([]address.Address, []*big.Int)

InitBalances returns the address that have initial balances and the corresponding amounts. The i-th amount is the i-th address' balance.

type Blockchain

type Blockchain struct {
	// Timestamp is the timestamp of the genesis block
	Timestamp int64
	// BlockGasLimit is the total gas limit could be consumed in a block
	BlockGasLimit uint64 `yaml:"blockGasLimit"`
	// ActionGasLimit is the per action gas limit cap
	ActionGasLimit uint64 `yaml:"actionGasLimit"`
	// BlockInterval is the interval between two blocks
	BlockInterval time.Duration `yaml:"blockInterval"`
	// NumSubEpochs is the number of sub epochs in one epoch of block production
	NumSubEpochs uint64 `yaml:"numSubEpochs"`
	// NumDelegates is the number of delegates that participate into one epoch of block production
	NumDelegates uint64 `yaml:"numDelegates"`
	// NumCandidateDelegates is the number of candidate delegates, who may be selected as a delegate via roll dpos
	NumCandidateDelegates uint64 `yaml:"numCandidateDelegates"`
	// TimeBasedRotation is the flag to enable rotating delegates' time slots on a block height
	TimeBasedRotation bool `yaml:"timeBasedRotation"`
}

Blockchain contains blockchain level configs

type Delegate

type Delegate struct {
	Address       string `yaml:"address"`
	Votes         uint64 `yaml:"votes"`
	RewardAddress string `yaml:"rewardAddress"`
}

Delegate defines a delegate with address and votes

type Genesis

type Genesis struct {
	Blockchain `yaml:"blockchain"`
	Account    `ymal:"account"`
	Poll       `yaml:"poll"`
	Rewarding  `yaml:"rewarding"`
}

Genesis is the root level of genesis config. Genesis config is the network-wide blockchain config. All the nodes participating into the same network should use EXACTLY SAME genesis config.

var (
	// Default contains the default genesis config
	Default Genesis
)

func New

func New() (Genesis, error)

New constructs a genesis config. It loads the default values, and could be overwritten by values defined in the yaml config files

type Poll

type Poll struct {
	// EnableBeaconChainVoting is a flag whether read voting from beacon chain
	EnableBeaconChainVoting bool `yaml:"enableBeaconChainVoting"`
	// InitBeaconChainHeight is the height in beacon chain where the init poll result stored
	InitBeaconChainHeight uint64 `yaml:"initBeaconChainHeight"`
	// CommitteeConfig is the config for committee
	CommitteeConfig committee.Config `yaml:"committeeConfig"`
	// Delegates is a list of delegates with votes
	Delegates []Delegate `yaml:"delegates"`
}

Poll contains the configs for poll protocol

type Rewarding

type Rewarding struct {
	// InitAdminAddrStr is the address of the initial rewarding protocol admin in encoded string format
	InitAdminAddrStr string `yaml:"initAdminAddr"`
	// InitBalanceStr is the initial balance of the rewarding protocol in decimal string format
	InitBalanceStr string `yaml:"initBalance"`
	// BlockReward is the block reward amount in decimal string format
	BlockRewardStr string `yaml:"blockReward"`
	// EpochReward is the epoch reward amount in decimal string format
	EpochRewardStr string `yaml:"epochReward"`
	// NumDelegatesForEpochReward is the number of top candidates that will share a epoch reward
	NumDelegatesForEpochReward uint64 `yaml:"numDelegatesForEpochReward"`
}

Rewarding contains the configs for rewarding protocol

func (*Rewarding) BlockReward

func (r *Rewarding) BlockReward() *big.Int

BlockReward returns the block reward amount

func (*Rewarding) EpochReward

func (r *Rewarding) EpochReward() *big.Int

EpochReward returns the epoch reward amount

func (*Rewarding) InitAdminAddr

func (r *Rewarding) InitAdminAddr() address.Address

InitAdminAddr returns the address of the initial rewarding protocol admin

func (*Rewarding) InitBalance

func (r *Rewarding) InitBalance() *big.Int

InitBalance returns the init balance of the rewarding fund