platformvm

package
v1.4.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 5, 2021 License: BSD-3-Clause Imports: 53 Imported by: 0

Documentation

Overview

(c) 2021, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

Constants

View Source 
const (
	// PercentDenominator is the denominator used to calculate percentages
	PercentDenominator = 1000000

	// MaxSubMinConsumptionRate is the % consumption that incentivizes staking
	// longer
	MaxSubMinConsumptionRate = 20000 // 2%
	// MinConsumptionRate is the minimum % consumption of the remaining tokens
	// to be minted
	MinConsumptionRate = 100000 // 10%

	// The maximum amount of weight on a validator is required to be no more
	// than [MaxValidatorWeightFactor] * the validator's stake amount.
	MaxValidatorWeightFactor uint64 = 5

	// SupplyCap is the maximum amount of AVAX that should ever exist
	SupplyCap = 720 * units.MegaAvax
)
View Source 
const (

	// BatchSize is the number of decision transaction to place into a block
	BatchSize = 30
)

Variables

View Source 
var (
	Codec        codec.Manager
	GenesisCodec codec.Manager
)

Codecs do serialization and deserialization

View Source 
var (
	ID = ids.ID{'p', 'l', 'a', 't', 'f', 'o', 'r', 'm', 'v', 'm'}
)

ID of the platform VM

Functions

func CanDelegate 

func CanDelegate(
	current,
	pending []*UnsignedAddDelegatorTx,
	new *UnsignedAddDelegatorTx,
	currentStake,
	maximumStake uint64,
) (bool, error)

CanDelegate returns if the [new] delegator can be added to a validator who has [current] and [pending] delegators. [currentStake] is the current amount of stake on the validator, include the [current] delegators. [maximumStake] is the maximum amount of stake that can be on the validator at any given time. It is assumed that the validator without adding [new] does not violate [maximumStake]. It is assumed that [pending]

func MaxStakeAmount 

func MaxStakeAmount(
	current,
	pending []*UnsignedAddDelegatorTx,
	startTime time.Time,
	endTime time.Time,
	currentStake uint64,
) (uint64, error)

Types

type APIBlockchain 

type APIBlockchain struct {
	// Blockchain's ID
	ID ids.ID `json:"id"`

	// Blockchain's (non-unique) human-readable name
	Name string `json:"name"`

	// Subnet that validates the blockchain
	SubnetID ids.ID `json:"subnetID"`

	// Virtual Machine the blockchain runs
	VMID ids.ID `json:"vmID"`
}

APIBlockchain is the representation of a blockchain used in API calls

type APIChain 

type APIChain struct {
	GenesisData string   `json:"genesisData"`
	VMID        ids.ID   `json:"vmID"`
	FxIDs       []ids.ID `json:"fxIDs"`
	Name        string   `json:"name"`
	SubnetID    ids.ID   `json:"subnetID"`
}

APIChain defines a chain that exists at the network's genesis. [GenesisData] is the initial state of the chain. [VMID] is the ID of the VM this chain runs. [FxIDs] are the IDs of the Fxs the chain supports. [Name] is a human-readable, non-unique name for the chain. [SubnetID] is the ID of the subnet that validates the chain

type APIOwner 

type APIOwner struct {
	Locktime  json.Uint64 `json:"locktime"`
	Threshold json.Uint32 `json:"threshold"`
	Addresses []string    `json:"addresses"`
}

APIOwner is the repr. of a reward owner sent over APIs.

type APIPrimaryDelegator 

type APIPrimaryDelegator struct {
	APIStaker
	RewardOwner     *APIOwner    `json:"rewardOwner,omitempty"`
	PotentialReward *json.Uint64 `json:"potentialReward,omitempty"`
}

APIPrimaryDelegator is the repr. of a primary network delegator sent over APIs.

type APIPrimaryValidator 

type APIPrimaryValidator struct {
	APIStaker
	// The owner the staking reward, if applicable, will go to
	RewardOwner        *APIOwner     `json:"rewardOwner,omitempty"`
	PotentialReward    *json.Uint64  `json:"potentialReward,omitempty"`
	DelegationFee      json.Float32  `json:"delegationFee"`
	ExactDelegationFee *json.Uint32  `json:"exactDelegationFee,omitempty"`
	Uptime             *json.Float32 `json:"uptime,omitempty"`
	Connected          *bool         `json:"connected,omitempty"`
	Staked             []APIUTXO     `json:"staked,omitempty"`
	// The delegators delegating to this validator
	Delegators []APIPrimaryDelegator `json:"delegators"`
}

APIPrimaryValidator is the repr. of a primary network validator sent over APIs.

type APIStaker 

type APIStaker struct {
	TxID        ids.ID       `json:"txID"`
	StartTime   json.Uint64  `json:"startTime"`
	EndTime     json.Uint64  `json:"endTime"`
	Weight      *json.Uint64 `json:"weight,omitempty"`
	StakeAmount *json.Uint64 `json:"stakeAmount,omitempty"`
	NodeID      string       `json:"nodeID"`
}

APIStaker is the representation of a staker sent via APIs. [TxID] is the txID of the transaction that added this staker. [Amount] is the amount of tokens being staked. [StartTime] is the Unix time when they start staking [Endtime] is the Unix time repr. of when they are done staking [NodeID] is the node ID of the staker

type APISubnet 

type APISubnet struct {
	// ID of the subnet
	ID ids.ID `json:"id"`

	// Each element of [ControlKeys] the address of a public key.
	// A transaction to add a validator to this subnet requires
	// signatures from [Threshold] of these keys to be valid.
	ControlKeys []string    `json:"controlKeys"`
	Threshold   json.Uint32 `json:"threshold"`
}

APISubnet is a representation of a subnet used in API calls

type APIUTXO 

type APIUTXO struct {
	Locktime json.Uint64 `json:"locktime"`
	Amount   json.Uint64 `json:"amount"`
	Address  string      `json:"address"`
	Message  string      `json:"message"`
}

APIUTXO is a UTXO on the Platform Chain that exists at the chain's genesis.

type AbortBlock 

type AbortBlock struct {
	DoubleDecisionBlock `serialize:"true"`
}

AbortBlock being accepted results in the proposal of its parent (which must be a proposal block) being rejected.

func (*AbortBlock) Verify 

func (a *AbortBlock) Verify() error

Verify this block performs a valid state transition.

The parent block must be a proposal

This function also sets onAcceptState if the verification passes.

type AddDelegatorArgs 

type AddDelegatorArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader
	APIStaker
	RewardAddress string `json:"rewardAddress"`
}

AddDelegatorArgs are the arguments to AddDelegator

type AddSubnetValidatorArgs 

type AddSubnetValidatorArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader
	APIStaker
	// ID of subnet to validate
	SubnetID string `json:"subnetID"`
}

AddSubnetValidatorArgs are the arguments to AddSubnetValidator

type AddValidatorArgs 

type AddValidatorArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader
	APIStaker
	// The address the staking reward, if applicable, will go to
	RewardAddress     string       `json:"rewardAddress"`
	DelegationFeeRate json.Float32 `json:"delegationFeeRate"`
}

AddValidatorArgs are the arguments to AddValidator

type AtomicBlock 

type AtomicBlock struct {
	CommonDecisionBlock `serialize:"true"`

	Tx Tx `serialize:"true" json:"tx"`
	// contains filtered or unexported fields
}

AtomicBlock being accepted results in the atomic transaction contained in the block to be accepted and committed to the chain.

func (*AtomicBlock) Accept 

func (ab *AtomicBlock) Accept() error

func (*AtomicBlock) Reject 

func (ab *AtomicBlock) Reject() error

func (*AtomicBlock) Verify 

func (ab *AtomicBlock) Verify() error

Verify this block performs a valid state transition.

The parent block must be a decision block

This function also sets onAcceptDB database if the verification passes.

type BaseTx 

type BaseTx struct {
	avax.BaseTx `serialize:"true" json:"inputs"`
	// contains filtered or unexported fields
}

BaseTx contains fields common to many transaction types. It should be embedded in transaction implementations.

func (*BaseTx) Verify 

func (tx *BaseTx) Verify(ctx *snow.Context, c codec.Manager) error

Verify returns nil iff this tx is well formed

type Block 

type Block interface {
	snowman.Block
	// contains filtered or unexported methods
}

Block is the common interface that all staking blocks must have

type BuildGenesisArgs 

type BuildGenesisArgs struct {
	AvaxAssetID   ids.ID                `json:"avaxAssetID"`
	NetworkID     json.Uint32           `json:"networkID"`
	UTXOs         []APIUTXO             `json:"utxos"`
	Validators    []APIPrimaryValidator `json:"validators"`
	Chains        []APIChain            `json:"chains"`
	Time          json.Uint64           `json:"time"`
	InitialSupply json.Uint64           `json:"initialSupply"`
	Message       string                `json:"message"`
	Encoding      formatting.Encoding   `json:"encoding"`
}

BuildGenesisArgs are the arguments used to create the genesis data of the Platform Chain. [NetworkID] is the ID of the network [UTXOs] are the UTXOs on the Platform Chain that exist at genesis. [Validators] are the validators of the primary network at genesis. [Chains] are the chains that exist at genesis. [Time] is the Platform Chain's time at network genesis.

type BuildGenesisReply 

type BuildGenesisReply struct {
	Bytes    string              `json:"bytes"`
	Encoding formatting.Encoding `json:"encoding"`
}

BuildGenesisReply is the reply from BuildGenesis

type Client 

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

Client ...

func NewClient 

func NewClient(uri string, requestTimeout time.Duration) *Client

NewClient returns a Client for interacting with the P Chain endpoint

func (*Client) AddDelegator 

func (c *Client) AddDelegator(
	user api.UserPass,
	from []string,
	changeAddr string,
	rewardAddress,
	nodeID string,
	stakeAmount,
	startTime,
	endTime uint64,
) (ids.ID, error)

AddDelegator issues a transaction to add a delegator to the primary network and returns the txID

func (*Client) AddSubnetValidator 

func (c *Client) AddSubnetValidator(
	user api.UserPass,
	from []string,
	changeAddr string,
	subnetID,
	nodeID string,
	stakeAmount,
	startTime,
	endTime uint64,
) (ids.ID, error)

AddSubnetValidator issues a transaction to add validator [nodeID] to subnet with ID [subnetID] and returns the txID

func (*Client) AddValidator 

func (c *Client) AddValidator(
	user api.UserPass,
	from []string,
	changeAddr string,
	rewardAddress,
	nodeID string,
	stakeAmount,
	startTime,
	endTime uint64,
	delegationFeeRate float32,
) (ids.ID, error)

AddValidator issues a transaction to add a validator to the primary network and returns the txID

func (*Client) CreateAddress 

func (c *Client) CreateAddress(user api.UserPass) (string, error)

CreateAddress creates a new address for [user]

func (*Client) CreateBlockchain 

func (c *Client) CreateBlockchain(
	user api.UserPass,
	from []string,
	changeAddr string,
	subnetID ids.ID,
	vmID string,
	fxIDs []string,
	name string,
	genesisData []byte,
) (ids.ID, error)

CreateBlockchain issues a CreateBlockchain transaction and returns the txID

func (*Client) CreateSubnet 

func (c *Client) CreateSubnet(
	user api.UserPass,
	from []string,
	changeAddr string,
	controlKeys []string,
	threshold uint32,
) (ids.ID, error)

CreateSubnet issues a transaction to create [subnet] and returns the txID

func (*Client) ExportAVAX 

func (c *Client) ExportAVAX(
	user api.UserPass,
	from []string,
	changeAddr string,
	to string,
	amount uint64,
) (ids.ID, error)

ExportAVAX issues an ExportAVAX transaction and returns the txID

func (*Client) ExportKey 

func (c *Client) ExportKey(user api.UserPass, address string) (string, error)

ExportKey returns the private key corresponding to [address] from [user]'s account

func (*Client) GetAtomicUTXOs 

func (c *Client) GetAtomicUTXOs(addrs []string, sourceChain string, limit uint32, startAddress, startUTXOID string) ([][]byte, api.Index, error)

GetAtomicUTXOs returns the byte representation of the atomic UTXOs controlled by [addresses] from [sourceChain]

func (*Client) GetBalance 

func (c *Client) GetBalance(address string) (*GetBalanceResponse, error)

GetBalance returns the balance of [address] on the P Chain

func (*Client) GetBlockchainStatus 

func (c *Client) GetBlockchainStatus(blockchainID string) (Status, error)

GetBlockchainStatus returns the current status of blockchain with ID: [blockchainID]

func (*Client) GetBlockchains 

func (c *Client) GetBlockchains() ([]APIBlockchain, error)

GetBlockchains returns the list of blockchains on the platform

func (*Client) GetCurrentSupply 

func (c *Client) GetCurrentSupply() (uint64, error)

GetCurrentSupply returns an upper bound on the supply of AVAX in the system

func (*Client) GetCurrentValidators 

func (c *Client) GetCurrentValidators(subnetID ids.ID) ([]interface{}, error)

GetCurrentValidators returns the list of current validators for subnet with ID [subnetID]

func (*Client) GetHeight 

func (c *Client) GetHeight() (uint64, error)

GetHeight returns the current block height of the P Chain

func (*Client) GetMaxStakeAmount 

func (c *Client) GetMaxStakeAmount(subnetID ids.ID, nodeID string, startTime, endTime uint64) (uint64, error)

GetMaxStakeAmount returns the maximum amount of nAVAX staking to the named node during the time period.

func (*Client) GetMinStake 

func (c *Client) GetMinStake() (uint64, uint64, error)

GetMinStake returns the minimum staking amount in nAVAX for validators and delegators respectively

func (*Client) GetPendingValidators 

func (c *Client) GetPendingValidators(subnetID ids.ID) ([]interface{}, []interface{}, error)

GetPendingValidators returns the list of pending validators for subnet with ID [subnetID]

func (*Client) GetRewardUTXOs 

func (c *Client) GetRewardUTXOs(args *api.GetTxArgs) ([][]byte, error)

GetRewardUTXOs returns the reward UTXOs for a transaction

func (*Client) GetStake 

func (c *Client) GetStake(addrs []string) (uint64, error)

GetStake returns the amount of nAVAX that [addresses] have cumulatively staked on the Primary Network.

func (*Client) GetStakingAssetID 

func (c *Client) GetStakingAssetID(subnetID ids.ID) (ids.ID, error)

GetStakingAssetID returns the assetID of the asset used for staking on subnet corresponding to [subnetID]

func (*Client) GetSubnets 

func (c *Client) GetSubnets(ids []ids.ID) ([]APISubnet, error)

GetSubnets returns information about the specified subnets

func (*Client) GetTotalStake 

func (c *Client) GetTotalStake() (uint64, error)

GetTotalStake returns the total amount (in nAVAX) staked on the network

func (*Client) GetTx 

func (c *Client) GetTx(txID ids.ID) ([]byte, error)

GetTx returns the byte representation of the transaction corresponding to [txID]

func (*Client) GetTxStatus 

func (c *Client) GetTxStatus(txID ids.ID, includeReason bool) (*GetTxStatusResponse, error)

GetTxStatus returns the status of the transaction corresponding to [txID]

func (*Client) GetUTXOs 

func (c *Client) GetUTXOs(addrs []string, limit uint32, startAddress, startUTXOID string) ([][]byte, api.Index, error)

GetUTXOs returns the byte representation of the UTXOs controlled by [addrs]

func (*Client) ImportAVAX 

func (c *Client) ImportAVAX(
	user api.UserPass,
	from []string,
	changeAddr,
	to,
	sourceChain string,
) (ids.ID, error)

ImportAVAX issues an ImportAVAX transaction and returns the txID

func (*Client) ImportKey 

func (c *Client) ImportKey(user api.UserPass, privateKey string) (string, error)

ImportKey imports the specified [privateKey] to [user]'s keystore

func (*Client) IssueTx 

func (c *Client) IssueTx(txBytes []byte) (ids.ID, error)

IssueTx issues the transaction and returns its transaction ID

func (*Client) ListAddresses 

func (c *Client) ListAddresses(user api.UserPass) ([]string, error)

ListAddresses returns an array of platform addresses controlled by [user]

func (*Client) SampleValidators 

func (c *Client) SampleValidators(subnetID ids.ID, sampleSize uint16) ([]string, error)

SampleValidators returns the nodeIDs of a sample of [sampleSize] validators from the current validator set for subnet with ID [subnetID]

func (*Client) ValidatedBy 

func (c *Client) ValidatedBy(blockchainID ids.ID) (ids.ID, error)

ValidatedBy returns the ID of the Subnet that validates [blockchainID]

func (*Client) Validates 

func (c *Client) Validates(subnetID ids.ID) ([]ids.ID, error)

Validates returns the list of blockchains that are validated by the subnet with ID [subnetID]

type CommitBlock 

type CommitBlock struct {
	DoubleDecisionBlock `serialize:"true"`
}

CommitBlock being accepted results in the proposal of its parent (which must be a proposal block) being enacted.

func (*CommitBlock) Verify 

func (c *CommitBlock) Verify() error

Verify this block performs a valid state transition.

The parent block must be a proposal

This function also sets onAcceptState if the verification passes.

type CommonBlock 

type CommonBlock struct {
	PrntID ids.ID `serialize:"true" json:"parentID"` // parent's ID
	Hght   uint64 `serialize:"true" json:"height"`   // This block's height. The genesis block is at height 0.
	// contains filtered or unexported fields
}

CommonBlock contains fields and methods common to all blocks in this VM.

func (*CommonBlock) Accept 

func (b *CommonBlock) Accept() error

func (*CommonBlock) Bytes 

func (b *CommonBlock) Bytes() []byte

Status returns the status of this block

func (*CommonBlock) Height 

func (b *CommonBlock) Height() uint64

Height returns this block's height. The genesis block has height 0.

func (*CommonBlock) ID 

func (b *CommonBlock) ID() ids.ID

ID returns the ID of this block

func (*CommonBlock) Parent 

func (b *CommonBlock) Parent() snowman.Block

Parent returns [b]'s parent

func (*CommonBlock) ParentID 

func (b *CommonBlock) ParentID() ids.ID

ParentID returns [b]'s parent's ID

func (*CommonBlock) Reject 

func (b *CommonBlock) Reject() error

func (*CommonBlock) Status 

func (b *CommonBlock) Status() choices.Status

Status returns the status of this block

func (*CommonBlock) Verify 

func (b *CommonBlock) Verify() error

type CommonDecisionBlock 

type CommonDecisionBlock struct {
	CommonBlock `serialize:"true"`
	// contains filtered or unexported fields
}

CommonDecisionBlock contains the fields and methods common to all decision blocks

func (*CommonDecisionBlock) Reject 

func (cdb *CommonDecisionBlock) Reject() error

type CreateBlockchainArgs 

type CreateBlockchainArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader
	// ID of Subnet that validates the new blockchain
	SubnetID ids.ID `json:"subnetID"`
	// ID of the VM the new blockchain is running
	VMID string `json:"vmID"`
	// IDs of the FXs the VM is running
	FxIDs []string `json:"fxIDs"`
	// Human-readable name for the new blockchain, not necessarily unique
	Name string `json:"name"`
	// Genesis state of the blockchain being created
	GenesisData string `json:"genesisData"`
	// Encoding format to use for genesis data
	Encoding formatting.Encoding `json:"encoding"`
}

CreateBlockchainArgs is the arguments for calling CreateBlockchain

type CreateSubnetArgs 

type CreateSubnetArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader
	// The ID member of APISubnet is ignored
	APISubnet
}

CreateSubnetArgs are the arguments to CreateSubnet

type DoubleDecisionBlock 

type DoubleDecisionBlock struct {
	CommonDecisionBlock `serialize:"true"`
}

DoubleDecisionBlock contains the accept for a pair of blocks

func (*DoubleDecisionBlock) Accept 

func (ddb *DoubleDecisionBlock) Accept() error

Accept implements the snowman.Block interface

type EventHeap 

type EventHeap struct {
	SortByStartTime bool  `serialize:"true"`
	Txs             []*Tx `serialize:"true"`
}

EventHeap is a collection of timedTxs where elements are ordered by either their startTime or their endTime. If SortByStartTime == true, the first element of [Txs] is the tx in the heap with the earliest startTime. Otherwise the first element is the tx with earliest endTime. The default value of this struct will order transactions by endTime. This struct implements the heap interface. Transactions must be syntactically verified before adding to EventHeap to ensure that EventHeap can always by marshalled.

func (*EventHeap) Add 

func (h *EventHeap) Add(tx *Tx)

Add ...

func (*EventHeap) Bytes 

func (h *EventHeap) Bytes() ([]byte, error)

Bytes returns the byte representation of this heap

func (*EventHeap) Len 

func (h *EventHeap) Len() int

func (*EventHeap) Less 

func (h *EventHeap) Less(i, j int) bool

func (*EventHeap) Peek 

func (h *EventHeap) Peek() *Tx

Peek ...

func (*EventHeap) Pop 

func (h *EventHeap) Pop() interface{}

Pop implements the heap interface

func (*EventHeap) Push 

func (h *EventHeap) Push(x interface{})

Push implements the heap interface

func (*EventHeap) Remove 

func (h *EventHeap) Remove() *Tx

Remove ...

func (*EventHeap) Swap 

func (h *EventHeap) Swap(i, j int)

func (*EventHeap) Timestamp 

func (h *EventHeap) Timestamp() time.Time

Timestamp returns the timestamp on the top transaction on the heap

type ExportAVAXArgs 

type ExportAVAXArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader

	// Amount of AVAX to send
	Amount json.Uint64 `json:"amount"`

	// ID of the address that will receive the AVAX. This address includes the
	// chainID, which is used to determine what the destination chain is.
	To string `json:"to"`
}

ExportAVAXArgs are the arguments to ExportAVAX

type ExportKeyArgs 

type ExportKeyArgs struct {
	api.UserPass
	Address string `json:"address"`
}

ExportKeyArgs are arguments for ExportKey

type ExportKeyReply 

type ExportKeyReply struct {
	// The decrypted PrivateKey for the Address provided in the arguments
	PrivateKey string `json:"privateKey"`
}

ExportKeyReply is the response for ExportKey

type Factory 

type Factory struct {
	// The node's chain manager
	Chains chains.Manager

	// Node's validator set maps subnetID -> validators of the subnet
	Validators validators.Manager

	// True if the node is being run with staking enabled
	StakingEnabled bool

	// Set of subnets that this node is validating
	WhitelistedSubnets ids.Set

	// Fee that must be burned by every state creating transaction
	CreationTxFee uint64

	// Fee that must be burned by every create staker transaction
	AddStakerTxFee uint64

	// Fee that is burned by every non-state creating transaction
	TxFee uint64

	// The minimum amount of tokens one must bond to be a validator
	MinValidatorStake uint64

	// The maximum amount of tokens that can be bonded on a validator
	MaxValidatorStake uint64

	// Minimum stake, in nAVAX, that can be delegated on the primary network
	MinDelegatorStake uint64

	// Minimum fee that can be charged for delegation
	MinDelegationFee uint32

	// UptimePercentage is the minimum uptime required to be rewarded for staking
	UptimePercentage float64

	// Minimum amount of time to allow a staker to stake
	MinStakeDuration time.Duration

	// Maximum amount of time to allow a staker to stake
	MaxStakeDuration time.Duration

	// Consumption period for the minting function
	StakeMintingPeriod time.Duration
}

Factory can create new instances of the Platform Chain

func (*Factory) New 

func (f *Factory) New(*snow.Context) (interface{}, error)

New returns a new instance of the Platform Chain

type Fx 

type Fx interface {
	// Initialize this feature extension to be running under this VM. Should
	// return an error if the VM is incompatible.
	Initialize(vm interface{}) error

	// Notify this Fx that the VM is in bootstrapping
	Bootstrapping() error

	// Notify this Fx that the VM is bootstrapped
	Bootstrapped() error

	// VerifyTransfer verifies that the specified transaction can spend the
	// provided utxo with no restrictions on the destination. If the transaction
	// can't spend the output based on the input and credential, a non-nil error
	// should be returned.
	VerifyTransfer(tx, in, cred, utxo interface{}) error

	// VerifyPermission returns nil iff [cred] proves that [controlGroup]
	// assents to [tx]
	VerifyPermission(tx, in, cred, controlGroup interface{}) error

	// CreateOutput creates a new output with the provided control group worth
	// the specified amount
	CreateOutput(amount uint64, controlGroup interface{}) (interface{}, error)
}

Fx is the interface a feature extension must implement to support the Platform Chain.

type Genesis 

type Genesis struct {
	UTXOs         []*GenesisUTXO `serialize:"true"`
	Validators    []*Tx          `serialize:"true"`
	Chains        []*Tx          `serialize:"true"`
	Timestamp     uint64         `serialize:"true"`
	InitialSupply uint64         `serialize:"true"`
	Message       string         `serialize:"true"`
}

Genesis represents a genesis state of the platform chain

func (*Genesis) Initialize 

func (g *Genesis) Initialize() error

Initialize ...

type GenesisUTXO 

type GenesisUTXO struct {
	avax.UTXO `serialize:"true"`
	Message   []byte `serialize:"true"`
}

GenesisUTXO adds messages to UTXOs

type GetBalanceResponse 

type GetBalanceResponse struct {
	// Balance, in nAVAX, of the address
	Balance            json.Uint64    `json:"balance"`
	Unlocked           json.Uint64    `json:"unlocked"`
	LockedStakeable    json.Uint64    `json:"lockedStakeable"`
	LockedNotStakeable json.Uint64    `json:"lockedNotStakeable"`
	UTXOIDs            []*avax.UTXOID `json:"utxoIDs"`
}

GetBalanceResponse ...

type GetBlockchainStatusArgs 

type GetBlockchainStatusArgs struct {
	BlockchainID string `json:"blockchainID"`
}

GetBlockchainStatusArgs is the arguments for calling GetBlockchainStatus [BlockchainID] is the ID of or an alias of the blockchain to get the status of.

type GetBlockchainStatusReply 

type GetBlockchainStatusReply struct {
	Status Status `json:"status"`
}

GetBlockchainStatusReply is the reply from calling GetBlockchainStatus Status is the blockchain's status.

type GetBlockchainsResponse 

type GetBlockchainsResponse struct {
	// blockchains that exist
	Blockchains []APIBlockchain `json:"blockchains"`
}

GetBlockchainsResponse is the response from a call to GetBlockchains

type GetCurrentSupplyReply 

type GetCurrentSupplyReply struct {
	Supply json.Uint64 `json:"supply"`
}

GetCurrentSupplyReply are the results from calling GetCurrentSupply

type GetCurrentValidatorsArgs 

type GetCurrentValidatorsArgs struct {
	// Subnet we're listing the validators of
	// If omitted, defaults to primary network
	SubnetID ids.ID `json:"subnetID"`
	// NodeIDs of validators to request. If [NodeIDs]
	// is empty, it fetches all current validators. If
	// some nodeIDs are not currently validators, they
	// will be omitted from the response.
	NodeIDs []string `json:"nodeIDs"`
}

GetCurrentValidatorsArgs are the arguments for calling GetCurrentValidators

type GetCurrentValidatorsReply 

type GetCurrentValidatorsReply struct {
	Validators []interface{} `json:"validators"`
}

GetCurrentValidatorsReply are the results from calling GetCurrentValidators. Each validator contains a list of delegators to itself.

type GetHeightResponse 

type GetHeightResponse struct {
	Height json.Uint64 `json:"height"`
}

GetHeightResponse ...

type GetMaxStakeAmountArgs 

type GetMaxStakeAmountArgs struct {
	SubnetID  ids.ID      `json:"subnetID"`
	NodeID    string      `json:"nodeID"`
	StartTime json.Uint64 `json:"startTime"`
	EndTime   json.Uint64 `json:"endTime"`
}

GetMaxStakeAmountArgs is the request for calling GetMaxStakeAmount.

type GetMaxStakeAmountReply 

type GetMaxStakeAmountReply struct {
	Amount json.Uint64 `json:"amount"`
}

GetMaxStakeAmountReply is the response from calling GetMaxStakeAmount.

type GetMinStakeReply 

type GetMinStakeReply struct {
	//  The minimum amount of tokens one must bond to be a validator
	MinValidatorStake json.Uint64 `json:"minValidatorStake"`
	// Minimum stake, in nAVAX, that can be delegated on the primary network
	MinDelegatorStake json.Uint64 `json:"minDelegatorStake"`
}

GetMinStakeReply is the response from calling GetMinStake.

type GetPendingValidatorsArgs 

type GetPendingValidatorsArgs struct {
	// Subnet we're getting the pending validators of
	// If omitted, defaults to primary network
	SubnetID ids.ID `json:"subnetID"`
	// NodeIDs of validators to request. If [NodeIDs]
	// is empty, it fetches all pending validators. If
	// some requested nodeIDs are not pending validators,
	// they are omitted from the response.
	NodeIDs []string `json:"nodeIDs"`
}

GetPendingValidatorsArgs are the arguments for calling GetPendingValidators

type GetPendingValidatorsReply 

type GetPendingValidatorsReply struct {
	Validators []interface{} `json:"validators"`
	Delegators []interface{} `json:"delegators"`
}

GetPendingValidatorsReply are the results from calling GetPendingValidators. Unlike GetCurrentValidatorsReply, each validator has a null delegator list.

type GetRewardUTXOsReply 

type GetRewardUTXOsReply struct {
	// Number of UTXOs returned
	NumFetched json.Uint64 `json:"numFetched"`
	// The UTXOs
	UTXOs []string `json:"utxos"`
	// Encoding specifies the encoding format the UTXOs are returned in
	Encoding formatting.Encoding `json:"encoding"`
}

GetRewardUTXOsReply defines the GetRewardUTXOs replies returned from the API

type GetStakeArgs 

type GetStakeArgs struct {
	api.JSONAddresses
	Encoding formatting.Encoding `json:"encoding"`
}

type GetStakeReply 

type GetStakeReply struct {
	Staked json.Uint64 `json:"staked"`
	// String representation of staked outputs
	// Each is of type avax.TransferableOutput
	Outputs []string `json:"stakedOutputs"`
	// Encoding of [Outputs]
	Encoding formatting.Encoding `json:"encoding"`
}

GetStakeReply is the response from calling GetStake.

type GetStakingAssetIDArgs 

type GetStakingAssetIDArgs struct {
	SubnetID ids.ID `json:"subnetID"`
}

GetStakingAssetIDArgs are the arguments to GetStakingAssetID

type GetStakingAssetIDResponse 

type GetStakingAssetIDResponse struct {
	AssetID ids.ID `json:"assetID"`
}

GetStakingAssetIDResponse is the response from calling GetStakingAssetID

type GetSubnetsArgs 

type GetSubnetsArgs struct {
	// IDs of the subnets to retrieve information about
	// If omitted, gets all subnets
	IDs []ids.ID `json:"ids"`
}

GetSubnetsArgs are the arguments to GetSubnet

type GetSubnetsResponse 

type GetSubnetsResponse struct {
	// Each element is a subnet that exists
	// Null if there are no subnets other than the primary network
	Subnets []APISubnet `json:"subnets"`
}

GetSubnetsResponse is the response from calling GetSubnets

type GetTotalStakeReply 

type GetTotalStakeReply struct {
	Stake json.Uint64 `json:"stake"`
}

GetTotalStakeReply is the response from calling GetTotalStake.

type GetTxStatusArgs 

type GetTxStatusArgs struct {
	TxID ids.ID `json:"txID"`
	// If IncludeReason is false returns a response that looks like:
	// {
	// 	"jsonrpc": "2.0",
	// 	"result": "Dropped",
	// 	"id": 1
	// }
	// If IncludeReason is true returns a response that looks like this:
	// {
	// 	"jsonrpc": "2.0",
	// 	"result": {
	//     "status":"[Status]",
	//     "reason":"[Reason tx was dropped, if applicable]"
	//  },
	// 	"id": 1
	// }
	// In the latter, "reason" is only present if the status is dropped
	IncludeReason bool `json:"includeReason"`
}

GetTxStatusArgs ...

type GetTxStatusResponse 

type GetTxStatusResponse struct {
	Status Status `json:"status"`
	// Reason this tx was dropped.
	// Only non-empty if Status is dropped
	Reason string `json:"reason,omitempty"`
}

GetTxStatusResponse ...

type GetUTXOsArgs 

type GetUTXOsArgs struct {
	Addresses   []string            `json:"addresses"`
	SourceChain string              `json:"sourceChain"`
	Limit       json.Uint32         `json:"limit"`
	StartIndex  Index               `json:"startIndex"`
	Encoding    formatting.Encoding `json:"encoding"`
}

GetUTXOsArgs are arguments for passing into GetUTXOs. Gets the UTXOs that reference at least one address in [Addresses]. If specified, [SourceChain] is the chain where the atomic UTXOs were exported from. If empty, or the Platform Chain ID is specified, then GetUTXOs fetches the native UTXOs. Returns at most [limit] addresses. If [limit] == 0 or > [maxUTXOsToFetch], fetches up to [maxUTXOsToFetch]. [StartIndex] defines where to start fetching UTXOs (for pagination.) UTXOs fetched are from addresses equal to or greater than [StartIndex.Address] For address [StartIndex.Address], only UTXOs with IDs greater than [StartIndex.UTXO] will be returned. If [StartIndex] is omitted, gets all UTXOs. If GetUTXOs is called multiple times, with our without [StartIndex], it is not guaranteed that returned UTXOs are unique. That is, the same UTXO may appear in the response of multiple calls. [Encoding] defines the encoding format to use for the returned UTXOs. Can be either "cb58" or "hex"

type GetUTXOsResponse 

type GetUTXOsResponse struct {
	// Number of UTXOs returned
	NumFetched json.Uint64 `json:"numFetched"`
	// The UTXOs
	UTXOs []string `json:"utxos"`
	// The last UTXO that was returned, and the address it corresponds to.
	// Used for pagination. To get the rest of the UTXOs, call GetUTXOs
	// again and set [StartIndex] to this value.
	EndIndex Index `json:"endIndex"`
	// Encoding specifies the format the UTXOs are returned in
	Encoding formatting.Encoding `json:"encoding"`
}

GetUTXOsResponse defines the GetUTXOs replies returned from the API

type ImportAVAXArgs 

type ImportAVAXArgs struct {
	// User, password, from addrs, change addr
	api.JSONSpendHeader

	// Chain the funds are coming from
	SourceChain string `json:"sourceChain"`

	// The address that will receive the imported funds
	To string `json:"to"`
}

ImportAVAXArgs are the arguments to ImportAVAX

type ImportKeyArgs 

type ImportKeyArgs struct {
	api.UserPass
	PrivateKey string `json:"privateKey"`
}

ImportKeyArgs are arguments for ImportKey

type Index 

type Index struct {
	Address string `json:"address"` // The address as a string
	UTXO    string `json:"utxo"`    // The UTXO ID as a string
}

Index is an address and an associated UTXO. Marks a starting or stopping point when fetching UTXOs. Used for pagination.

type InternalState 

type InternalState interface {
	MutableState
	uptime.State

	AddCurrentStaker(tx *Tx, potentialReward uint64)
	DeleteCurrentStaker(tx *Tx)

	AddPendingStaker(tx *Tx)
	DeletePendingStaker(tx *Tx)

	SetCurrentStakerChainState(currentStakerChainState)
	SetPendingStakerChainState(pendingStakerChainState)

	GetLastAccepted() ids.ID
	SetLastAccepted(ids.ID)

	GetBlock(blockID ids.ID) (Block, error)
	AddBlock(block Block)

	UTXOIDs(addr []byte, start ids.ID, limit int) ([]ids.ID, error)

	Abort()
	Commit() error
	CommitBatch() (database.Batch, error)
	Close() error

	SetMigrated() error
	IsMigrated() (bool, error)
}

func NewInternalState 

func NewInternalState(vm *VM, db database.Database, genesis []byte) (InternalState, error)

func NewMeteredInternalState 

func NewMeteredInternalState(vm *VM, db database.Database, genesis []byte, namespace string, metrics prometheus.Registerer) (InternalState, error)

type Mempool 

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

Mempool implements a simple mempool to convert txs into valid blocks

func (*Mempool) BuildBlock 

func (m *Mempool) BuildBlock() (snowman.Block, error)

BuildBlock builds a block to be added to consensus

func (*Mempool) Initialize 

func (m *Mempool) Initialize(vm *VM)

Initialize this mempool.

func (*Mempool) IssueTx 

func (m *Mempool) IssueTx(tx *Tx) error

IssueTx enqueues the [tx] to be put into a block

func (*Mempool) ResetTimer 

func (m *Mempool) ResetTimer()

ResetTimer Check if there is a block ready to be added to consensus. If so, notify the consensus engine.

func (*Mempool) Shutdown 

func (m *Mempool) Shutdown()

Shutdown this mempool

type MutableState 

type MutableState interface {
	UTXOState

	AddRewardUTXO(txID ids.ID, utxo *avax.UTXO)
	GetRewardUTXOs(txID ids.ID) ([]*avax.UTXO, error)

	GetTimestamp() time.Time
	SetTimestamp(time.Time)

	GetCurrentSupply() uint64
	SetCurrentSupply(uint64)

	GetSubnets() ([]*Tx, error)
	AddSubnet(createSubnetTx *Tx)

	GetChains(subnetID ids.ID) ([]*Tx, error)
	AddChain(createChainTx *Tx)

	GetTx(txID ids.ID) (*Tx, Status, error)
	AddTx(tx *Tx, status Status)

	CurrentStakerChainState() currentStakerChainState
	PendingStakerChainState() pendingStakerChainState
}

type Owned 

type Owned interface {
	Owners() interface{}
}

Owned ...

type ProposalBlock 

type ProposalBlock struct {
	CommonBlock `serialize:"true"`

	Tx Tx `serialize:"true" json:"tx"`
	// contains filtered or unexported fields
}

ProposalBlock is a proposal to change the chain's state.

A proposal may be to:

  1. Advance the chain's timestamp (*AdvanceTimeTx)
  2. Remove a staker from the staker set (*RewardStakerTx)
  3. Add a new staker to the set of pending (future) stakers (*AddValidatorTx, *AddDelegatorTx, *AddSubnetValidatorTx)

The proposal will be enacted (change the chain's state) if the proposal block is accepted and followed by an accepted Commit block

func (*ProposalBlock) Accept 

func (pb *ProposalBlock) Accept() error

func (*ProposalBlock) Options 

func (pb *ProposalBlock) Options() ([2]snowman.Block, error)

Options returns the possible children of this block in preferential order.

func (*ProposalBlock) Reject 

func (pb *ProposalBlock) Reject() error

Reject implements the snowman.Block interface

func (*ProposalBlock) Verify 

func (pb *ProposalBlock) Verify() error

Verify this block is valid.

The parent block must either be a Commit or an Abort block.

If this block is valid, this function also sets pas.onCommit and pas.onAbort.

type SampleValidatorsArgs 

type SampleValidatorsArgs struct {
	// Number of validators in the sample
	Size json.Uint16 `json:"size"`

	// ID of subnet to sample validators from
	// If omitted, defaults to the primary network
	SubnetID ids.ID `json:"subnetID"`
}

SampleValidatorsArgs are the arguments for calling SampleValidators

type SampleValidatorsReply 

type SampleValidatorsReply struct {
	Validators []string `json:"validators"`
}

SampleValidatorsReply are the results from calling Sample

type Service 

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

Service defines the API calls that can be made to the platform chain

func (*Service) AddDelegator 

func (service *Service) AddDelegator(_ *http.Request, args *AddDelegatorArgs, reply *api.JSONTxIDChangeAddr) error

AddDelegator creates and signs and issues a transaction to add a delegator to the primary network

func (*Service) AddSubnetValidator 

func (service *Service) AddSubnetValidator(_ *http.Request, args *AddSubnetValidatorArgs, response *api.JSONTxIDChangeAddr) error

AddSubnetValidator creates and signs and issues a transaction to add a validator to a subnet other than the primary network

func (*Service) AddValidator 

func (service *Service) AddValidator(_ *http.Request, args *AddValidatorArgs, reply *api.JSONTxIDChangeAddr) error

AddValidator creates and signs and issues a transaction to add a validator to the primary network

func (*Service) CreateAddress 

func (service *Service) CreateAddress(_ *http.Request, args *api.UserPass, response *api.JSONAddress) error

CreateAddress creates an address controlled by [args.Username] Returns the newly created address

func (*Service) CreateBlockchain 

func (service *Service) CreateBlockchain(_ *http.Request, args *CreateBlockchainArgs, response *api.JSONTxIDChangeAddr) error

CreateBlockchain issues a transaction to create a new blockchain

func (*Service) CreateSubnet 

func (service *Service) CreateSubnet(_ *http.Request, args *CreateSubnetArgs, response *api.JSONTxIDChangeAddr) error

CreateSubnet creates and signs and issues a transaction to create a new subnet

func (*Service) ExportAVAX 

func (service *Service) ExportAVAX(_ *http.Request, args *ExportAVAXArgs, response *api.JSONTxIDChangeAddr) error

ExportAVAX exports AVAX from the P-Chain to the X-Chain It must be imported on the X-Chain to complete the transfer

func (*Service) ExportKey 

func (service *Service) ExportKey(r *http.Request, args *ExportKeyArgs, reply *ExportKeyReply) error

ExportKey returns a private key from the provided user

func (*Service) GetBalance 

func (service *Service) GetBalance(_ *http.Request, args *api.JSONAddress, response *GetBalanceResponse) error

GetBalance gets the balance of an address

func (*Service) GetBlockchainStatus 

func (service *Service) GetBlockchainStatus(_ *http.Request, args *GetBlockchainStatusArgs, reply *GetBlockchainStatusReply) error

GetBlockchainStatus gets the status of a blockchain with the ID [args.BlockchainID].

func (*Service) GetBlockchains 

func (service *Service) GetBlockchains(_ *http.Request, args *struct{}, response *GetBlockchainsResponse) error

GetBlockchains returns all of the blockchains that exist

func (*Service) GetCurrentSupply 

func (service *Service) GetCurrentSupply(_ *http.Request, _ *struct{}, reply *GetCurrentSupplyReply) error

GetCurrentSupply returns an upper bound on the supply of AVAX in the system

func (*Service) GetCurrentValidators 

func (service *Service) GetCurrentValidators(_ *http.Request, args *GetCurrentValidatorsArgs, reply *GetCurrentValidatorsReply) error

GetCurrentValidators returns current validators and delegators

func (*Service) GetHeight 

func (service *Service) GetHeight(r *http.Request, args *struct{}, response *GetHeightResponse) error

GetHeight returns the height of the last accepted block

func (*Service) GetMaxStakeAmount 

func (service *Service) GetMaxStakeAmount(_ *http.Request, args *GetMaxStakeAmountArgs, reply *GetMaxStakeAmountReply) error

GetMaxStakeAmount returns the maximum amount of nAVAX staking to the named node during the time period.

func (*Service) GetMinStake 

func (service *Service) GetMinStake(_ *http.Request, _ *struct{}, reply *GetMinStakeReply) error

GetMinStake returns the minimum staking amount in nAVAX.

func (*Service) GetPendingValidators 

func (service *Service) GetPendingValidators(_ *http.Request, args *GetPendingValidatorsArgs, reply *GetPendingValidatorsReply) error

GetPendingValidators returns the list of pending validators

func (*Service) GetRewardUTXOs 

func (service *Service) GetRewardUTXOs(_ *http.Request, args *api.GetTxArgs, reply *GetRewardUTXOsReply) error

GetRewardUTXOs returns the UTXOs that were rewarded after the provided transaction's staking period ended.

func (*Service) GetStake 

func (service *Service) GetStake(_ *http.Request, args *GetStakeArgs, response *GetStakeReply) error

GetStake returns the amount of nAVAX that [args.Addresses] have cumulatively staked on the Primary Network.

This method assumes that each stake output has only owner This method assumes only AVAX can be staked This method only concerns itself with the Primary Network, not subnets TODO: Improve the performance of this method by maintaining this data in a data structure rather than re-calculating it by iterating over stakers

func (*Service) GetStakingAssetID 

func (service *Service) GetStakingAssetID(_ *http.Request, args *GetStakingAssetIDArgs, response *GetStakingAssetIDResponse) error

GetStakingAssetID returns the assetID of the token used to stake on the provided subnet

func (*Service) GetSubnets 

func (service *Service) GetSubnets(_ *http.Request, args *GetSubnetsArgs, response *GetSubnetsResponse) error

GetSubnets returns the subnets whose ID are in [args.IDs] The response will include the primary network

func (*Service) GetTotalStake 

func (service *Service) GetTotalStake(_ *http.Request, _ *struct{}, reply *GetTotalStakeReply) error

GetTotalStake returns the total amount staked on the Primary Network

func (*Service) GetTx 

func (service *Service) GetTx(_ *http.Request, args *api.GetTxArgs, response *api.FormattedTx) error

GetTx gets a tx

func (*Service) GetTxStatus 

func (service *Service) GetTxStatus(_ *http.Request, args *GetTxStatusArgs, response *GetTxStatusResponse) error

GetTxStatus gets a tx's status

func (*Service) GetUTXOs 

func (service *Service) GetUTXOs(_ *http.Request, args *GetUTXOsArgs, response *GetUTXOsResponse) error

GetUTXOs returns the UTXOs controlled by the given addresses

func (*Service) ImportAVAX 

func (service *Service) ImportAVAX(_ *http.Request, args *ImportAVAXArgs, response *api.JSONTxIDChangeAddr) error

ImportAVAX issues a transaction to import AVAX from the X-chain. The AVAX must have already been exported from the X-Chain.

func (*Service) ImportKey 

func (service *Service) ImportKey(r *http.Request, args *ImportKeyArgs, reply *api.JSONAddress) error

ImportKey adds a private key to the provided user

func (*Service) IssueTx 

func (service *Service) IssueTx(_ *http.Request, args *api.FormattedTx, response *api.JSONTxID) error

IssueTx issues a tx

func (*Service) ListAddresses 

func (service *Service) ListAddresses(_ *http.Request, args *api.UserPass, response *api.JSONAddresses) error

ListAddresses returns the addresses controlled by [args.Username]

func (*Service) SampleValidators 

func (service *Service) SampleValidators(_ *http.Request, args *SampleValidatorsArgs, reply *SampleValidatorsReply) error

SampleValidators returns a sampling of the list of current validators

func (*Service) ValidatedBy 

func (service *Service) ValidatedBy(_ *http.Request, args *ValidatedByArgs, response *ValidatedByResponse) error

ValidatedBy returns the ID of the Subnet that validates [args.BlockchainID]

func (*Service) Validates 

func (service *Service) Validates(_ *http.Request, args *ValidatesArgs, response *ValidatesResponse) error

Validates returns the IDs of the blockchains validated by [args.SubnetID]

type SingleDecisionBlock 

type SingleDecisionBlock struct {
	CommonDecisionBlock `serialize:"true"`
}

SingleDecisionBlock contains the accept for standalone decision blocks

func (*SingleDecisionBlock) Accept 

func (sdb *SingleDecisionBlock) Accept() error

Accept implements the snowman.Block interface

type StakeableLockIn 

type StakeableLockIn struct {
	Locktime            uint64 `serialize:"true" json:"locktime"`
	avax.TransferableIn `serialize:"true"`
}

StakeableLockIn ...

func (*StakeableLockIn) Verify 

func (s *StakeableLockIn) Verify() error

Verify ...

type StakeableLockOut 

type StakeableLockOut struct {
	Locktime             uint64 `serialize:"true" json:"locktime"`
	avax.TransferableOut `serialize:"true"`
}

StakeableLockOut ...

func (*StakeableLockOut) Addresses 

func (s *StakeableLockOut) Addresses() [][]byte

Addresses ...

func (*StakeableLockOut) Verify 

func (s *StakeableLockOut) Verify() error

Verify ...

type StandardBlock 

type StandardBlock struct {
	SingleDecisionBlock `serialize:"true"`

	Txs []*Tx `serialize:"true" json:"txs"`
}

StandardBlock being accepted results in the transactions contained in the block to be accepted and committed to the chain.

func (*StandardBlock) Reject 

func (sb *StandardBlock) Reject() error

func (*StandardBlock) Verify 

func (sb *StandardBlock) Verify() error

Verify this block performs a valid state transition.

The parent block must be a proposal

This function also sets onAcceptDB database if the verification passes.

type StaticService 

type StaticService struct{}

StaticService defines the static API methods exposed by the platform VM

func (*StaticService) BuildGenesis 

func (ss *StaticService) BuildGenesis(_ *http.Request, args *BuildGenesisArgs, reply *BuildGenesisReply) error

BuildGenesis build the genesis state of the Platform Chain (and thereby the Avalanche network.)

type Status 

type Status uint32

Status ... 

const (
	Unknown Status = iota
	Preferred
	Created
	Validating
	Committed
	Aborted
	Processing
	Dropped
)

List of possible status values Unknown Zero value, means the status is not known Preferred means the operation is known and preferred, but hasn't been decided yet Created means the operation occurred, but isn't managed locally Validating means the operation was accepted and is managed locally

func (Status) MarshalJSON 

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON ...

func (Status) String 

func (s Status) String() string

func (*Status) UnmarshalJSON 

func (s *Status) UnmarshalJSON(b []byte) error

UnmarshalJSON ...

func (Status) Valid 

func (s Status) Valid() error

Valid returns nil if the status is a valid status.

type Subnet 

type Subnet interface {
	// ID returns this subnet's ID
	ID() ids.ID

	// Validators returns the validators that compose this subnet
	Validators() []validators.Validator
}

A Subnet is a set of validators that are validating a set of blockchains Each blockchain is validated by one subnet; one subnet may validate many blockchains

type SubnetValidator 

type SubnetValidator struct {
	Validator `serialize:"true"`

	// ID of the subnet this validator is validating
	Subnet ids.ID `serialize:"true" json:"subnet"`
}

SubnetValidator validates a subnet on the Avalanche network.

func (*SubnetValidator) SubnetID 

func (v *SubnetValidator) SubnetID() ids.ID

SubnetID is the ID of the subnet this validator is validating

func (*SubnetValidator) Verify 

func (v *SubnetValidator) Verify() error

Verify this validator is valid

type TimedTx 

type TimedTx interface {
	ID() ids.ID
	StartTime() time.Time
	EndTime() time.Time
	Weight() uint64
	Bytes() []byte
}

TimedTx ...

type Tx 

type Tx struct {
	// The body of this transaction
	UnsignedTx `serialize:"true" json:"unsignedTx"`

	// The credentials of this transaction
	Creds []verify.Verifiable `serialize:"true" json:"credentials"`
}

Tx is a signed transaction

func (*Tx) Sign 

func (tx *Tx) Sign(c codec.Manager, signers [][]*crypto.PrivateKeySECP256K1R) error

Sign this transaction with the provided signers

type TxError 

type TxError interface {
	error
	Temporary() bool
}

TxError provides the ability for errors to be distinguished as permanent or temporary

type UTXOAdder 

type UTXOAdder interface {
	AddUTXO(utxo *avax.UTXO)
}

type UTXODeleter 

type UTXODeleter interface {
	DeleteUTXO(utxoID ids.ID)
}

type UTXOGetter 

type UTXOGetter interface {
	GetUTXO(utxoID ids.ID) (*avax.UTXO, error)
}

type UTXOState 

type UTXOState interface {
	UTXOGetter
	UTXOAdder
	UTXODeleter
}

type UnsignedAddDelegatorTx 

type UnsignedAddDelegatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// Describes the delegatee
	Validator Validator `serialize:"true" json:"validator"`
	// Where to send staked tokens when done validating
	Stake []*avax.TransferableOutput `serialize:"true" json:"stake"`
	// Where to send staking rewards when done validating
	RewardsOwner verify.Verifiable `serialize:"true" json:"rewardsOwner"`
}

UnsignedAddDelegatorTx is an unsigned addDelegatorTx

func (*UnsignedAddDelegatorTx) EndTime 

func (tx *UnsignedAddDelegatorTx) EndTime() time.Time

EndTime of this validator

func (*UnsignedAddDelegatorTx) InitiallyPrefersCommit 

func (tx *UnsignedAddDelegatorTx) InitiallyPrefersCommit(vm *VM) bool

InitiallyPrefersCommit returns true if the proposed validators start time is after the current wall clock time,

func (*UnsignedAddDelegatorTx) SemanticVerify 

func (tx *UnsignedAddDelegatorTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (
	VersionedState,
	VersionedState,
	func() error,
	func() error,
	TxError,
)

SemanticVerify this transaction is valid.

func (*UnsignedAddDelegatorTx) StartTime 

func (tx *UnsignedAddDelegatorTx) StartTime() time.Time

StartTime of this validator

func (*UnsignedAddDelegatorTx) Verify 

func (tx *UnsignedAddDelegatorTx) Verify(
	ctx *snow.Context,
	c codec.Manager,
	minDelegatorStake uint64,
	minStakeDuration time.Duration,
	maxStakeDuration time.Duration,
) error

Verify return nil iff [tx] is valid

func (*UnsignedAddDelegatorTx) Weight 

func (tx *UnsignedAddDelegatorTx) Weight() uint64

Weight of this validator

type UnsignedAddSubnetValidatorTx 

type UnsignedAddSubnetValidatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// The validator
	Validator SubnetValidator `serialize:"true" json:"validator"`
	// Auth that will be allowing this validator into the network
	SubnetAuth verify.Verifiable `serialize:"true" json:"subnetAuthorization"`
}

UnsignedAddSubnetValidatorTx is an unsigned addSubnetValidatorTx

func (*UnsignedAddSubnetValidatorTx) EndTime 

func (tx *UnsignedAddSubnetValidatorTx) EndTime() time.Time

EndTime of this validator

func (*UnsignedAddSubnetValidatorTx) InitiallyPrefersCommit 

func (tx *UnsignedAddSubnetValidatorTx) InitiallyPrefersCommit(vm *VM) bool

InitiallyPrefersCommit returns true if the proposed validators start time is after the current wall clock time,

func (*UnsignedAddSubnetValidatorTx) SemanticVerify 

func (tx *UnsignedAddSubnetValidatorTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (
	VersionedState,
	VersionedState,
	func() error,
	func() error,
	TxError,
)

SemanticVerify this transaction is valid.

func (*UnsignedAddSubnetValidatorTx) StartTime 

func (tx *UnsignedAddSubnetValidatorTx) StartTime() time.Time

StartTime of this validator

func (*UnsignedAddSubnetValidatorTx) Verify 

func (tx *UnsignedAddSubnetValidatorTx) Verify(
	ctx *snow.Context,
	c codec.Manager,
	feeAmount uint64,
	feeAssetID ids.ID,
	minStakeDuration time.Duration,
	maxStakeDuration time.Duration,
) error

Verify return nil iff [tx] is valid

func (*UnsignedAddSubnetValidatorTx) Weight 

func (tx *UnsignedAddSubnetValidatorTx) Weight() uint64

Weight of this validator

type UnsignedAddValidatorTx 

type UnsignedAddValidatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// Describes the delegatee
	Validator Validator `serialize:"true" json:"validator"`
	// Where to send staked tokens when done validating
	Stake []*avax.TransferableOutput `serialize:"true" json:"stake"`
	// Where to send staking rewards when done validating
	RewardsOwner verify.Verifiable `serialize:"true" json:"rewardsOwner"`
	// Fee this validator charges delegators as a percentage, times 10,000
	// For example, if this validator has Shares=300,000 then they take 30% of rewards from delegators
	Shares uint32 `serialize:"true" json:"shares"`
}

UnsignedAddValidatorTx is an unsigned addValidatorTx

func (*UnsignedAddValidatorTx) EndTime 

func (tx *UnsignedAddValidatorTx) EndTime() time.Time

EndTime of this validator

func (*UnsignedAddValidatorTx) InitiallyPrefersCommit 

func (tx *UnsignedAddValidatorTx) InitiallyPrefersCommit(vm *VM) bool

InitiallyPrefersCommit returns true if the proposed validators start time is after the current wall clock time,

func (*UnsignedAddValidatorTx) SemanticVerify 

func (tx *UnsignedAddValidatorTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (
	VersionedState,
	VersionedState,
	func() error,
	func() error,
	TxError,
)

SemanticVerify this transaction is valid.

func (*UnsignedAddValidatorTx) StartTime 

func (tx *UnsignedAddValidatorTx) StartTime() time.Time

StartTime of this validator

func (*UnsignedAddValidatorTx) Verify 

func (tx *UnsignedAddValidatorTx) Verify(
	ctx *snow.Context,
	c codec.Manager,
	minStake uint64,
	maxStake uint64,
	minStakeDuration time.Duration,
	maxStakeDuration time.Duration,
	minDelegationFee uint32,
) error

Verify return nil iff [tx] is valid

func (*UnsignedAddValidatorTx) Weight 

func (tx *UnsignedAddValidatorTx) Weight() uint64

Weight of this validator

type UnsignedAdvanceTimeTx 

type UnsignedAdvanceTimeTx struct {
	avax.Metadata

	// Unix time this block proposes increasing the timestamp to
	Time uint64 `serialize:"true" json:"time"`
}

UnsignedAdvanceTimeTx is a transaction to increase the chain's timestamp. When the chain's timestamp is updated (a AdvanceTimeTx is accepted and followed by a commit block) the staker set is also updated accordingly. It must be that:

  • proposed timestamp > [current chain time]
  • proposed timestamp <= [time for next staker set change]

func (*UnsignedAdvanceTimeTx) InitiallyPrefersCommit 

func (tx *UnsignedAdvanceTimeTx) InitiallyPrefersCommit(vm *VM) bool

InitiallyPrefersCommit returns true if the proposed time is at or before the current time plus the synchrony bound

func (*UnsignedAdvanceTimeTx) SemanticVerify 

func (tx *UnsignedAdvanceTimeTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (
	VersionedState,
	VersionedState,
	func() error,
	func() error,
	TxError,
)

SemanticVerify this transaction is valid.

func (*UnsignedAdvanceTimeTx) Timestamp 

func (tx *UnsignedAdvanceTimeTx) Timestamp() time.Time

Timestamp returns the time this block is proposing the chain should be set to

type UnsignedAtomicTx 

type UnsignedAtomicTx interface {
	UnsignedTx

	// UTXOs this tx consumes
	InputUTXOs() ids.Set
	// Attempts to verify this transaction with the provided state.
	SemanticVerify(vm *VM, parentState MutableState, stx *Tx) (VersionedState, TxError)

	// Accept this transaction with the additionally provided state transitions.
	Accept(ctx *snow.Context, batch database.Batch) error
}

UnsignedAtomicTx is an unsigned operation that can be atomically accepted

type UnsignedCreateChainTx 

type UnsignedCreateChainTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// ID of the Subnet that validates this blockchain
	SubnetID ids.ID `serialize:"true" json:"subnetID"`
	// A human readable name for the chain; need not be unique
	ChainName string `serialize:"true" json:"chainName"`
	// ID of the VM running on the new chain
	VMID ids.ID `serialize:"true" json:"vmID"`
	// IDs of the feature extensions running on the new chain
	FxIDs []ids.ID `serialize:"true" json:"fxIDs"`
	// Byte representation of genesis state of the new chain
	GenesisData []byte `serialize:"true" json:"genesisData"`
	// Auth that will be allowing this validator into the network
	SubnetAuth verify.Verifiable `serialize:"true" json:"subnetAuthorization"`
}

UnsignedCreateChainTx is an unsigned CreateChainTx

func (*UnsignedCreateChainTx) SemanticVerify 

func (tx *UnsignedCreateChainTx) SemanticVerify(
	vm *VM,
	vs VersionedState,
	stx *Tx,
) (
	func() error,
	TxError,
)

SemanticVerify this transaction is valid.

func (*UnsignedCreateChainTx) Verify 

func (tx *UnsignedCreateChainTx) Verify(
	ctx *snow.Context,
	c codec.Manager,
	feeAmount uint64,
	feeAssetID ids.ID,
) error

Verify this transaction is well-formed

type UnsignedCreateSubnetTx 

type UnsignedCreateSubnetTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// Who is authorized to manage this subnet
	Owner verify.Verifiable `serialize:"true" json:"owner"`
}

UnsignedCreateSubnetTx is an unsigned proposal to create a new subnet

func (*UnsignedCreateSubnetTx) SemanticVerify 

func (tx *UnsignedCreateSubnetTx) SemanticVerify(
	vm *VM,
	vs VersionedState,
	stx *Tx,
) (
	func() error,
	TxError,
)

SemanticVerify returns nil if [tx] is valid given the state in [db]

func (*UnsignedCreateSubnetTx) Verify 

func (tx *UnsignedCreateSubnetTx) Verify(
	ctx *snow.Context,
	c codec.Manager,
	feeAmount uint64,
	feeAssetID ids.ID,
) error

Verify this transaction is well-formed

type UnsignedDecisionTx 

type UnsignedDecisionTx interface {
	UnsignedTx

	// Attempts to verify this transaction with the provided state.
	SemanticVerify(vm *VM, vs VersionedState, stx *Tx) (
		onAcceptFunc func() error,
		err TxError,
	)
}

UnsignedDecisionTx is an unsigned operation that can be immediately decided

type UnsignedExportTx 

type UnsignedExportTx struct {
	BaseTx `serialize:"true"`

	// Which chain to send the funds to
	DestinationChain ids.ID `serialize:"true" json:"destinationChain"`

	// Outputs that are exported to the chain
	ExportedOutputs []*avax.TransferableOutput `serialize:"true" json:"exportedOutputs"`
}

UnsignedExportTx is an unsigned ExportTx

func (*UnsignedExportTx) Accept 

func (tx *UnsignedExportTx) Accept(ctx *snow.Context, batch database.Batch) error

Accept this transaction.

func (*UnsignedExportTx) InputUTXOs 

func (tx *UnsignedExportTx) InputUTXOs() ids.Set

InputUTXOs returns an empty set

func (*UnsignedExportTx) SemanticVerify 

func (tx *UnsignedExportTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (VersionedState, TxError)

SemanticVerify this transaction is valid.

func (*UnsignedExportTx) Verify 

func (tx *UnsignedExportTx) Verify(
	avmID ids.ID,
	ctx *snow.Context,
	c codec.Manager,
	feeAmount uint64,
	feeAssetID ids.ID,
) error

Verify this transaction is well-formed

type UnsignedImportTx 

type UnsignedImportTx struct {
	BaseTx `serialize:"true"`

	// Which chain to consume the funds from
	SourceChain ids.ID `serialize:"true" json:"sourceChain"`

	// Inputs that consume UTXOs produced on the chain
	ImportedInputs []*avax.TransferableInput `serialize:"true" json:"importedInputs"`
}

UnsignedImportTx is an unsigned ImportTx

func (*UnsignedImportTx) Accept 

func (tx *UnsignedImportTx) Accept(ctx *snow.Context, batch database.Batch) error

Accept this transaction and spend imported inputs We spend imported UTXOs here rather than in semanticVerify because we don't want to remove an imported UTXO in semanticVerify only to have the transaction not be Accepted. This would be inconsistent. Recall that imported UTXOs are not kept in a versionDB.

func (*UnsignedImportTx) InputUTXOs 

func (tx *UnsignedImportTx) InputUTXOs() ids.Set

InputUTXOs returns the UTXOIDs of the imported funds

func (*UnsignedImportTx) SemanticVerify 

func (tx *UnsignedImportTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (VersionedState, TxError)

SemanticVerify this transaction is valid.

func (*UnsignedImportTx) Verify 

func (tx *UnsignedImportTx) Verify(
	avmID ids.ID,
	ctx *snow.Context,
	c codec.Manager,
	feeAmount uint64,
	feeAssetID ids.ID,
) error

Verify this transaction is well-formed

type UnsignedProposalTx 

type UnsignedProposalTx interface {
	UnsignedTx

	// Attempts to verify this transaction with the provided state.
	SemanticVerify(vm *VM, state MutableState, stx *Tx) (
		onCommitState VersionedState,
		onAbortState VersionedState,
		onCommitFunc func() error,
		onAbortFunc func() error,
		err TxError,
	)
	InitiallyPrefersCommit(vm *VM) bool
}

UnsignedProposalTx is an unsigned operation that can be proposed

type UnsignedRewardValidatorTx 

type UnsignedRewardValidatorTx struct {
	avax.Metadata

	// ID of the tx that created the delegator/validator being removed/rewarded
	TxID ids.ID `serialize:"true" json:"txID"`
	// contains filtered or unexported fields
}

UnsignedRewardValidatorTx is a transaction that represents a proposal to remove a validator that is currently validating from the validator set.

If this transaction is accepted and the next block accepted is a Commit block, the validator is removed and the address that the validator specified receives the staked AVAX as well as a validating reward.

If this transaction is accepted and the next block accepted is an Abort block, the validator is removed and the address that the validator specified receives the staked AVAX but no reward.

func (*UnsignedRewardValidatorTx) InitiallyPrefersCommit 

func (tx *UnsignedRewardValidatorTx) InitiallyPrefersCommit(*VM) bool

InitiallyPrefersCommit returns true if this node thinks the validator should receive a staking reward.

TODO: A validator should receive a reward only if they are sufficiently responsive and correct during the time they are validating. Right now they receive a reward if they're up (but not necessarily correct and responsive) for a sufficient amount of time

func (*UnsignedRewardValidatorTx) SemanticVerify 

func (tx *UnsignedRewardValidatorTx) SemanticVerify(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (
	VersionedState,
	VersionedState,
	func() error,
	func() error,
	TxError,
)

SemanticVerify this transaction performs a valid state transition.

The current validating set must have at least one member. The next validator to be removed must be the validator specified in this block. The next validator to be removed must be have an end time equal to the current 

chain timestamp.

type UnsignedTx 

type UnsignedTx interface {
	Initialize(unsignedBytes, signedBytes []byte)
	ID() ids.ID
	UnsignedBytes() []byte
	Bytes() []byte
}

UnsignedTx is an unsigned transaction

type VM 

type VM struct {
	Factory

	avax.AddressManager
	avax.AtomicUTXOManager
	uptime.Manager
	// contains filtered or unexported fields
}

VM implements the snowman.ChainVM interface

func (*VM) AcceptBlock 

func (m *VM) AcceptBlock(b snowman.Block) error

func (*VM) AcceptTx 

func (m *VM) AcceptTx(tx *Tx) error

func (*VM) Bootstrapped 

func (vm *VM) Bootstrapped() error

Bootstrapped marks this VM as bootstrapped

func (*VM) Bootstrapping 

func (vm *VM) Bootstrapping() error

Bootstrapping marks this VM as bootstrapping

func (*VM) BuildBlock 

func (vm *VM) BuildBlock() (snowman.Block, error)

BuildBlock builds a block to be added to consensus

func (*VM) Clock 

func (vm *VM) Clock() *timer.Clock

func (*VM) Codec 

func (vm *VM) Codec() codec.Manager

func (*VM) CodecRegistry 

func (vm *VM) CodecRegistry() codec.Registry

func (*VM) Connected 

func (vm *VM) Connected(vdrID ids.ShortID) error

Connected implements validators.Connector

func (*VM) CreateHandlers 

func (vm *VM) CreateHandlers() (map[string]*common.HTTPHandler, error)

CreateHandlers returns a map where: * keys are API endpoint extensions * values are API handlers

func (*VM) CreateStaticHandlers 

func (vm *VM) CreateStaticHandlers() (map[string]*common.HTTPHandler, error)

CreateStaticHandlers returns a map where: * keys are API endpoint extensions * values are API handlers

func (*VM) Disconnected 

func (vm *VM) Disconnected(vdrID ids.ShortID) error

Disconnected implements validators.Connector

func (*VM) GetBlock 

func (vm *VM) GetBlock(blkID ids.ID) (snowman.Block, error)

GetBlock implements the snowman.ChainVM interface

func (*VM) HealthCheck 

func (vm *VM) HealthCheck() (interface{}, error)

Health implements the common.VM interface

func (*VM) Initialize 

func (vm *VM) Initialize(
	ctx *snow.Context,
	dbManager manager.Manager,
	genesisBytes []byte,
	upgradeBytes []byte,
	configBytes []byte,
	msgs chan<- common.Message,
	_ []*common.Fx,
) error

Initialize this blockchain. [vm.ChainManager] and [vm.vdrMgr] must be set before this function is called.

func (*VM) LastAccepted 

func (vm *VM) LastAccepted() (ids.ID, error)

LastAccepted returns the block most recently accepted

func (*VM) Logger 

func (vm *VM) Logger() logging.Logger

func (*VM) NotifyBlockReady 

func (vm *VM) NotifyBlockReady()

NotifyBlockReady tells the consensus engine that a new block is ready to be created

func (*VM) ParseBlock 

func (vm *VM) ParseBlock(b []byte) (snowman.Block, error)

ParseBlock implements the snowman.ChainVM interface

func (*VM) Preferred 

func (vm *VM) Preferred() (Block, error)

func (*VM) PreferredHeight 

func (vm *VM) PreferredHeight() (uint64, error)

func (*VM) SetPreference 

func (vm *VM) SetPreference(blkID ids.ID) error

SetPreference sets the preferred block to be the one with ID [blkID]

func (*VM) Shutdown 

func (vm *VM) Shutdown() error

Shutdown this blockchain

type ValidatedByArgs 

type ValidatedByArgs struct {
	// ValidatedBy returns the ID of the Subnet validating the blockchain with this ID
	BlockchainID ids.ID `json:"blockchainID"`
}

ValidatedByArgs is the arguments for calling ValidatedBy

type ValidatedByResponse 

type ValidatedByResponse struct {
	// ID of the Subnet validating the specified blockchain
	SubnetID ids.ID `json:"subnetID"`
}

ValidatedByResponse is the reply from calling ValidatedBy

type ValidatesArgs 

type ValidatesArgs struct {
	SubnetID ids.ID `json:"subnetID"`
}

ValidatesArgs are the arguments to Validates

type ValidatesResponse 

type ValidatesResponse struct {
	BlockchainIDs []ids.ID `json:"blockchainIDs"`
}

ValidatesResponse is the response from calling Validates

type Validator 

type Validator struct {
	// Node ID of the validator
	NodeID ids.ShortID `serialize:"true" json:"nodeID"`

	// Unix time this validator starts validating
	Start uint64 `serialize:"true" json:"start"`

	// Unix time this validator stops validating
	End uint64 `serialize:"true" json:"end"`

	// Weight of this validator used when sampling
	Wght uint64 `serialize:"true" json:"weight"`
}

Validator is a validator.

func (*Validator) BoundedBy 

func (v *Validator) BoundedBy(startTime, endTime time.Time) bool

BoundedBy returns true iff the period that [validator] validates is a (non-strict) subset of the time that [other] validates. Namely, startTime <= v.StartTime() <= v.EndTime() <= endTime

func (*Validator) Duration 

func (v *Validator) Duration() time.Duration

Duration is the amount of time that this validator will be in the validator set

func (*Validator) EndTime 

func (v *Validator) EndTime() time.Time

EndTime is the time that this validator will leave the validator set

func (*Validator) ID 

func (v *Validator) ID() ids.ShortID

ID returns the node ID of the validator

func (*Validator) StartTime 

func (v *Validator) StartTime() time.Time

StartTime is the time that this validator will enter the validator set

func (*Validator) Verify 

func (v *Validator) Verify() error

Verify validates the ID for this validator

func (*Validator) Weight 

func (v *Validator) Weight() uint64

Weight is this validator's weight when sampling

type VersionedState 

type VersionedState interface {
	MutableState

	SetBase(MutableState)
	Apply(InternalState)
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.