genesis

Documentation

Index

• Constants
• Variables
• func GetStateLockup(r chain.Rules) (uint64, error)
• type CustomAllocation
• type Genesis
  • func Default() *Genesis
  • func New(b []byte, _ []byte) (*Genesis, error)
  • func (g *Genesis) GetHRP() string
  • func (g *Genesis) Load(ctx context.Context, tracer trace.Tracer, db chain.Database) error
  • func (g *Genesis) Rules(chainID ids.ID, _ int64) *Rules
• type Rules
  • func (r *Rules) FetchCustom(f string) (any, bool)
  • func (r *Rules) GetBaseUnits() uint64
  • func (r *Rules) GetBlockCostChangeDenominator() uint64
  • func (r *Rules) GetChainID() ids.ID
  • func (r *Rules) GetMaxBlockTxs() int
  • func (r *Rules) GetMaxBlockUnits() uint64
  • func (r *Rules) GetMinBlockCost() uint64
  • func (r *Rules) GetMinUnitPrice() uint64
  • func (r *Rules) GetUnitPriceChangeDenominator() uint64
  • func (r *Rules) GetValidityWindow() int64
  • func (r *Rules) GetWindowTargetBlocks() uint64
  • func (r *Rules) GetWindowTargetUnits() uint64

Constants

const (
	StateLockupField = "state_lockup"
)

Variables

var (
	ErrInvalidTarget      = errors.New("invalid target")
	ErrStateLockupMissing = errors.New("state lockup parameter missing")
)

Functions

func GetStateLockup

func GetStateLockup(r chain.Rules) (uint64, error)

Types

type CustomAllocation

type CustomAllocation struct {
	Address string `json:"address"` // bech32 address
	Balance uint64 `json:"balance"`
}

type Genesis

type Genesis struct {
	// Address prefix
	HRP string `json:"hrp"`

	// Block params
	MaxBlockTxs   int    `json:"maxBlockTxs"`
	MaxBlockUnits uint64 `json:"maxBlockUnits"` // must be possible to reach before block too large

	// Tx params
	BaseUnits      uint64 `json:"baseUnits"`
	StateLockup    uint64 `json:"stateLockup"`    // cost per key added to state
	ValidityWindow int64  `json:"validityWindow"` // seconds

	// Unit pricing
	MinUnitPrice               uint64 `json:"minUnitPrice"`
	UnitPriceChangeDenominator uint64 `json:"unitPriceChangeDenominator"`
	WindowTargetUnits          uint64 `json:"windowTargetUnits"` // 10s

	// Block pricing
	MinBlockCost               uint64 `json:"minBlockCost"`
	BlockCostChangeDenominator uint64 `json:"blockCostChangeDenominator"`
	WindowTargetBlocks         uint64 `json:"windowTargetBlocks"` // 10s

	// Allocations
	CustomAllocation []*CustomAllocation `json:"customAllocation"`
}

func Default

func Default() *Genesis

func New

func New(b []byte, _ []byte) (*Genesis, error)

func (*Genesis) GetHRP

func (g *Genesis) GetHRP() string

func (*Genesis) Load

func (g *Genesis) Load(ctx context.Context, tracer trace.Tracer, db chain.Database) error

func (*Genesis) Rules

func (g *Genesis) Rules(chainID ids.ID, _ int64) *Rules

TODO: use upgradeBytes

type Rules

type Rules struct {
	// contains filtered or unexported fields
}

func (*Rules) FetchCustom

func (r *Rules) FetchCustom(f string) (any, bool)

func (*Rules) GetBaseUnits

func (r *Rules) GetBaseUnits() uint64

func (*Rules) GetBlockCostChangeDenominator

func (r *Rules) GetBlockCostChangeDenominator() uint64

func (*Rules) GetChainID

func (r *Rules) GetChainID() ids.ID

func (*Rules) GetMaxBlockTxs

func (r *Rules) GetMaxBlockTxs() int

func (*Rules) GetMaxBlockUnits

func (r *Rules) GetMaxBlockUnits() uint64

func (*Rules) GetMinBlockCost

func (r *Rules) GetMinBlockCost() uint64

func (*Rules) GetMinUnitPrice

func (r *Rules) GetMinUnitPrice() uint64

func (*Rules) GetUnitPriceChangeDenominator

func (r *Rules) GetUnitPriceChangeDenominator() uint64

func (*Rules) GetValidityWindow

func (r *Rules) GetValidityWindow() int64

func (*Rules) GetWindowTargetBlocks

func (r *Rules) GetWindowTargetBlocks() uint64

func (*Rules) GetWindowTargetUnits

func (r *Rules) GetWindowTargetUnits() uint64