chains

Documentation

Index

• type Awaiter
• type ChainParameters
• type Manager
  • func New(stakingEnabled bool, log logging.Logger, logFactory logging.Factory, ...) Manager
• type MockManager
  • func (mm MockManager) AddRegistrant(Registrant)
  • func (mm MockManager) Alias(ids.ID, string) error
  • func (mm MockManager) Aliases(ids.ID) []string
  • func (mm MockManager) CreateChain(ChainParameters)
  • func (mm MockManager) ForceCreateChain(ChainParameters)
  • func (mm MockManager) Lookup(string) (ids.ID, error)
  • func (mm MockManager) LookupVM(string) (ids.ID, error)
  • func (mm MockManager) Router() router.Router
  • func (mm MockManager) Shutdown()
• type Registrant

Types

type Awaiter

type Awaiter interface {
	AwaitConnections(awaiting *networking.AwaitingConnections)
}

Awaiter can await connections to be connected

type ChainParameters

type ChainParameters struct {
	ID          ids.ID   // The ID of the chain being created
	SubnetID    ids.ID   // ID of the subnet that validates this chain
	GenesisData []byte   // The genesis data of this chain's ledger
	VMAlias     string   // The ID of the vm this chain is running
	FxAliases   []string // The IDs of the feature extensions this chain is running

	CustomBeacons validators.Set // Should only be set if the default beacons can't be used.
}

ChainParameters defines the chain being created

type Manager

type Manager interface {
	// Return the router this Manager is using to route consensus messages to chains
	Router() router.Router

	// Create a chain in the future
	CreateChain(ChainParameters)

	// Create a chain now
	ForceCreateChain(ChainParameters)

	// Add a registrant [r]. Every time a chain is
	// created, [r].RegisterChain([new chain]) is called
	AddRegistrant(Registrant)

	// Given an alias, return the ID of the chain associated with that alias
	Lookup(string) (ids.ID, error)

	// Given an alias, return the ID of the VM associated with that alias
	LookupVM(string) (ids.ID, error)

	// Return the aliases associated with a chain
	Aliases(ids.ID) []string

	// Add an alias to a chain
	Alias(ids.ID, string) error

	Shutdown()
}

Manager manages the chains running on this node. It can:

• Create a chain
• Add a registrant. When a chain is created, each registrant calls RegisterChain with the new chain as the argument.
• Get the aliases associated with a given chain.
• Get the ID of the chain associated with a given alias.

func New

func New(
	stakingEnabled bool,
	log logging.Logger,
	logFactory logging.Factory,
	vmManager vms.Manager,
	decisionEvents *triggers.EventDispatcher,
	consensusEvents *triggers.EventDispatcher,
	db database.Database,
	router router.Router,
	sender sender.ExternalSender,
	consensusParams avacon.Parameters,
	validators validators.Manager,
	nodeID ids.ShortID,
	networkID uint32,
	awaiter Awaiter,
	server *api.Server,
	keystore *keystore.Keystore,
	sharedMemory *atomic.SharedMemory,
) Manager

New returns a new Manager where:

<db> is this node's database
<sender> sends messages to other validators
<validators> validate this chain

TODO: Make this function take less arguments

type MockManager

type MockManager struct{}

MockManager implements Manager but does nothing. Always returns nil error. To be used only in tests (namely in package platformvm)

func (MockManager) AddRegistrant

func (mm MockManager) AddRegistrant(Registrant)

AddRegistrant ...

func (MockManager) Alias

func (mm MockManager) Alias(ids.ID, string) error

Alias ...

func (MockManager) Aliases

func (mm MockManager) Aliases(ids.ID) []string

Aliases ...

func (MockManager) CreateChain

func (mm MockManager) CreateChain(ChainParameters)

CreateChain ...

func (MockManager) ForceCreateChain

func (mm MockManager) ForceCreateChain(ChainParameters)

ForceCreateChain ...

func (MockManager) Lookup

func (mm MockManager) Lookup(string) (ids.ID, error)

Lookup ...

func (MockManager) LookupVM

func (mm MockManager) LookupVM(string) (ids.ID, error)

LookupVM ...

func (MockManager) Router

func (mm MockManager) Router() router.Router

Router ...

func (MockManager) Shutdown

func (mm MockManager) Shutdown()

Shutdown ...

type Registrant

type Registrant interface {
	RegisterChain(ctx *snow.Context, vm interface{})
}

Registrant can register the existence of a chain