genesis

Documentation

Index

• Variables
• func BuildFromMap(m map[string][]byte, gen *Genesis) error
• func CreateTestGenesisJSONFile(asRaw bool) (string, error)
• func NewGenesisBlockFromTrie(t *trie.Trie) (*types.Header, error)
• func NewTrieFromGenesis(g *Genesis) (*trie.Trie, error)
• type Data
• type Fields
• type Genesis
  • func NewGenesisFromJSON(file string, authCount int) (*Genesis, error)
  • func NewGenesisFromJSONRaw(file string) (*Genesis, error)
  • func (g *Genesis) GenesisData() *Data
  • func (g *Genesis) GenesisFields() Fields

Variables

var TestFieldsHR = Fields{
	Raw: map[string]map[string]string{},
	Runtime: map[string]map[string]interface{}{
		"system": {
			"code": "mocktestcode",
		},
	},
}

TestFieldsHR instance of human-readable Fields struct for testing, use with TestGenesis

var TestFieldsRaw = Fields{
	Raw: map[string]map[string]string{
		"top": {"0x3a636f6465": "mocktestcode"},
	},
}

TestFieldsRaw instance of raw Fields struct for testing use with TestGenesis

var TestGenesis = &Genesis{
	Name:       "gossamer",
	ID:         "gossamer",
	Bootnodes:  testBootnodes,
	ProtocolID: testProtocolID,
	Properties: testProperties,
	ForkBlocks: testForkBlocks,
	BadBlocks:  testBadBlocks,
}

TestGenesis instance of Genesis struct for testing

Functions

func BuildFromMap

func BuildFromMap(m map[string][]byte, gen *Genesis) error

BuildFromMap builds genesis fields data from map

func CreateTestGenesisJSONFile

func CreateTestGenesisJSONFile(asRaw bool) (string, error)

CreateTestGenesisJSONFile utility to create mock test genesis JSON file

func NewGenesisBlockFromTrie

func NewGenesisBlockFromTrie(t *trie.Trie) (*types.Header, error)

NewGenesisBlockFromTrie creates a genesis block from the provided trie

func NewTrieFromGenesis

func NewTrieFromGenesis(g *Genesis) (*trie.Trie, error)

NewTrieFromGenesis creates a new trie from the raw genesis data

Types

type Data

type Data struct {
	Name            string
	ID              string
	ChainType       string
	Bootnodes       [][]byte
	ProtocolID      string
	Properties      map[string]interface{}
	ForkBlocks      []string
	BadBlocks       []string
	ConsensusEngine string
}

Data defines the genesis file data formatted for trie storage

type Fields

type Fields struct {
	Raw     map[string]map[string]string      `json:"raw"`
	Runtime map[string]map[string]interface{} `json:"runtime,omitempty"`
}

Fields stores genesis raw data, and human readable runtime data

type Genesis

type Genesis struct {
	Name            string                 `json:"name"`
	ID              string                 `json:"id"`
	ChainType       string                 `json:"chainType"`
	Bootnodes       []string               `json:"bootNodes"`
	ProtocolID      string                 `json:"protocolId"`
	Genesis         Fields                 `json:"genesis"`
	Properties      map[string]interface{} `json:"properties"`
	ForkBlocks      []string               `json:"forkBlocks"`
	BadBlocks       []string               `json:"badBlocks"`
	ConsensusEngine string                 `json:"consensusEngine"`
}

Genesis stores the data parsed from the genesis configuration file

func NewGenesisFromJSON

func NewGenesisFromJSON(file string, authCount int) (*Genesis, error)

NewGenesisFromJSON parses Human Readable JSON formatted genesis file.Name. If authCount > 0, then it keeps only `authCount` number of authorities for babe and grandpa.

func NewGenesisFromJSONRaw

func NewGenesisFromJSONRaw(file string) (*Genesis, error)

NewGenesisFromJSONRaw parses a JSON formatted genesis-raw file

func (*Genesis) GenesisData

func (g *Genesis) GenesisData() *Data

GenesisData formats genesis for trie storage

func (*Genesis) GenesisFields

func (g *Genesis) GenesisFields() Fields

GenesisFields returns the genesis fields including genesis raw data