shardingconfig

Documentation

Overview

Package shardingconfig defines types and utilities that deal with nordicenergy sharding configuration schedule.

Index

• Constants
• Variables
• type Instance
  • func MustNewInstance(numShards uint32, numNodesPerShard, numnordicenergyOperatedNodesPerShard int, ...) Instance
  • func NewInstance(numShards uint32, numNodesPerShard, numnordicenergyOperatedNodesPerShard int, ...) (Instance, error)
• type NetworkID
• type Schedule
  • func NewFixedSchedule(instance Instance) Schedule

Constants

const (

	// MainNetHTTPPattern is the http pattern for mainnet.
	MainNetHTTPPattern = "https://api.s%d.t.nordicenergy.io"
	// MainNetWSPattern is the websocket pattern for mainnet.
	MainNetWSPattern = "wss://ws.s%d.t.nordicenergy.io"
)

const (

	// PangaeaHTTPPattern is the http pattern for pangaea.
	PangaeaHTTPPattern = "https://api.s%d.os.nordicenergy.io"
	// PangaeaWSPattern is the websocket pattern for pangaea.
	PangaeaWSPattern = "wss://ws.s%d.os.nordicenergy.io"
)

const (

	// PartnerHTTPPattern is the http pattern for partner.
	PartnerHTTPPattern = "https://api.s%d.ps.nordicenergy.io"
	// PartnerWSPattern is the websocket pattern for partner.
	PartnerWSPattern = "wss://ws.s%d.ps.nordicenergy.io"
)

const (

	// StressNetHTTPPattern is the http pattern for stressnet.
	StressNetHTTPPattern = "https://api.s%d.stn.nordicenergy.io"
	// StressNetWSPattern is the websocket pattern for stressnet.
	StressNetWSPattern = "wss://ws.s%d.stn.nordicenergy.io"
)

const (

	// TestNetHTTPPattern is the http pattern for testnet.
	TestNetHTTPPattern = "https://api.s%d.b.nordicenergy.io"
	// TestNetWSPattern is the websocket pattern for testnet.
	TestNetWSPattern = "wss://ws.s%d.b.nordicenergy.io"
)

const (
	// VLBPE is a Very Large Block Per Epoch
	VLBPE = 1000000000000
)

Variables

var LocalnetSchedule localnetSchedule

LocalnetSchedule is the local testnet sharding configuration schedule.

var MainnetSchedule mainnetSchedule

MainnetSchedule is the mainnet sharding configuration schedule.

var PangaeaSchedule pangaeaSchedule

PangaeaSchedule is the Pangaea sharding configuration schedule.

var PartnerSchedule partnerSchedule

PartnerSchedule is the long-running public partner sharding configuration schedule.

var StressNetSchedule stressnetSchedule

StressNetSchedule is the long-running public stressNet sharding configuration schedule.

var TestnetSchedule testnetSchedule

TestnetSchedule is the long-running public testnet sharding configuration schedule.

Types

type Instance

type Instance interface {
	// NumShards returns the number of shards in the network.
	NumShards() uint32

	// NumNodesPerShard returns number of nodes in each shard.
	NumNodesPerShard() int

	// NumnordicenergyOperatedNodesPerShard returns number of nodes in each shard
	// that are operated by nordicenergy.
	NumnordicenergyOperatedNodesPerShard() int

	// ExternalVotePercent returns total percentage of voting power external validators possess.
	ExternalVotePercent() numeric.Dec

	// FnAccounts returns a list of Foundational node accounts
	FnAccounts() []genesis.DeployAccount

	// FindAccount returns the deploy account based on the blskey
	FindAccount(blsPubKey string) (bool, *genesis.DeployAccount)

	// ReshardingEpoch returns a list of Epoch while off-chain resharding happens
	ReshardingEpoch() []*big.Int

	// Count of blocks per epoch
	BlocksPerEpoch() uint64
	// contains filtered or unexported methods
}

Instance is net sharding configuration instance.

func MustNewInstance

func MustNewInstance(
	numShards uint32,
	numNodesPerShard, numnordicenergyOperatedNodesPerShard int,
	nordicenergyVotePercent numeric.Dec,
	ngyAccounts []genesis.DeployAccount,
	fnAccounts []genesis.DeployAccount,
	reshardingEpoch []*big.Int, blocksPerEpoch uint64,
) Instance

MustNewInstance creates a new sharding configuration based upon given parameters. It panics if parameter validation fails. It is intended to be used for static initialization.

func NewInstance

func NewInstance(
	numShards uint32, numNodesPerShard, numnordicenergyOperatedNodesPerShard int, nordicenergyVotePercent numeric.Dec,
	ngyAccounts []genesis.DeployAccount,
	fnAccounts []genesis.DeployAccount,
	reshardingEpoch []*big.Int, blocksE uint64,
) (Instance, error)

NewInstance creates and validates a new sharding configuration based upon given parameters.

type NetworkID

type NetworkID byte

NetworkID is the network type of the blockchain.

const (
	MainNet NetworkID = iota
	TestNet
	LocalNet
	Pangaea
	Partner
	StressNet
	DevNet
)

Constants for NetworkID.

type Schedule

type Schedule interface {
	InstanceForEpoch(epoch *big.Int) Instance

	// CalcEpochNumber returns the epoch number based on the block number
	CalcEpochNumber(blockNum uint64) *big.Int

	// IsLastBlock check if the block is the last block in the epoch
	// NOTE: This method is very critical for the epoch transition logic and other checks.
	IsLastBlock(blockNum uint64) bool

	// EpochLastBlock returns the last block number of an epoch
	// NOTE: This method id important for a few rpcs and validator APR calculation
	EpochLastBlock(epochNum uint64) uint64

	// VDFDifficulty returns number of iterations for VDF calculation
	VdfDifficulty() int

	// TODO: remove it after randomness feature turned on mainnet
	//RandomnessStartingEpoch returns starting epoch of randonness generation
	RandomnessStartingEpoch() uint64

	// GetNetworkID() return networkID type.
	GetNetworkID() NetworkID

	// GetShardingStructure returns sharding structure.
	GetShardingStructure(int, int) []map[string]interface{}

	// IsSkippedEpoch returns if epoch was skipped on shard chain
	IsSkippedEpoch(uint32, *big.Int) bool
}

Schedule returns the sharding configuration instance for the given epoch.

func NewFixedSchedule

func NewFixedSchedule(instance Instance) Schedule

NewFixedSchedule returns a sharding configuration schedule that uses the given config instance for all epochs. Useful for testing.