Documentation
¶
Index ¶
- type ChainParameters
- type Manager
- type ManagerConfig
- 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) IsBootstrapped(ids.ID) bool
- func (mm MockManager) Lookup(s string) (ids.ID, error)
- func (mm MockManager) LookupVM(s string) (ids.ID, error)
- func (mm MockManager) Router() router.Router
- func (mm MockManager) Shutdown()
- func (mm MockManager) SubnetID(ids.ID) (ids.ID, error)
- type Registrant
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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
// Returns the ID of the subnet that is validating the provided chain
SubnetID(chainID ids.ID) (ids.ID, error)
// Returns true iff the chain with the given ID exists and is finished bootstrapping
IsBootstrapped(ids.ID) bool
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(config *ManagerConfig) 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 ManagerConfig ¶ added in v0.8.0
type ManagerConfig struct {
StakingEnabled bool // True iff the network has staking enabled
MaxNonStakerPendingMsgs uint32
StakerMSGPortion float64
StakerCPUPortion float64
Log logging.Logger
LogFactory logging.Factory
VMManager vms.Manager // Manage mappings from vm ID --> vm
DecisionEvents *triggers.EventDispatcher
ConsensusEvents *triggers.EventDispatcher
DB database.Database
Router router.Router // Routes incoming messages to the appropriate chain
Net network.Network // Sends consensus messages to other validators
ConsensusParams avcon.Parameters // The consensus parameters (alpha, beta, etc.) for new chains
Validators validators.Manager // Validators validating on this chain
NodeID ids.ShortID // The ID of this node
NetworkID uint32 // ID of the network this node is connected to
Server *api.Server // Handles HTTP API calls
Keystore *keystore.Keystore
AtomicMemory *atomic.Memory
AVAXAssetID ids.ID
XChainID ids.ID
CriticalChains ids.Set // Chains that can't exit gracefully
TimeoutManager *timeout.Manager // Manages request timeouts when sending messages to other validators
}
ManagerConfig ...
type MockManager ¶
type MockManager struct{}
MockManager implements Manager but does nothing. Always returns nil error. To be used only in tests
func (MockManager) AddRegistrant ¶
func (mm MockManager) AddRegistrant(Registrant)
AddRegistrant ...
func (MockManager) ForceCreateChain ¶
func (mm MockManager) ForceCreateChain(ChainParameters)
ForceCreateChain ...
func (MockManager) IsBootstrapped ¶ added in v0.8.0
func (mm MockManager) IsBootstrapped(ids.ID) bool
IsBootstrapped ...
type Registrant ¶
Registrant can register the existence of a chain
Click to show internal directories.
Click to hide internal directories.