platformvm

package
v1.7.11-rc-12 Latest Latest
Warning

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

 Go to latest Published: May 14, 2022 License: BSD-3-Clause Imports: 62 Imported by: 59

README

PlatformVM

Mempool Gossiping

The PlatformVM has a mempool which tracks unconfirmed transactions that are waiting to be issued into blocks. The mempool is volatile, i.e. it does not persist unconfirmed transactions.

In conjunction with the introduction of Snowman++, the mempool was opened to the network, allowing the gossiping of local transactions as well as the hosting of remote ones.

Mempool Gossiping Workflow

The PlatformVM's mempool performs the following workflow:

  • An unconfirmed transaction is provided to node A, either through mempool gossiping or direct issuance over a RPC. If this transaction isn't already in the local mempool, the transaction is issued into the mempool.
  • When node A issues a new transaction into its mempool, it will gossip the transaction ID by sending an AppGossip message. The node's engine will randomly select peers (currently defaulting to 6 nodes) to send the AppGossip message to.
  • When node B learns about the existence of a remote transaction ID, it will check if its mempool contains the transaction or if it has been recently dropped. If the transaction ID is not known, node B will generate a new requestID and respond with an AppRequest message with the unknown transaction's ID. node B will track the content of the request issued with requestID for response verification.
  • Upon reception of an AppRequest message, node A will attempt to fetch the transaction requested in the AppRequest message from its mempool. Note that a transaction advertised in an AppGossip message may no longer be in the mempool, because they may have been included into a block, rejected, or dropped. If the transaction is retrieved, it is encoded into an AppResponse message. The AppResponse message will carry the same requestID of the originating AppRequest message and it will be sent back to node B.
  • If node B receives an AppResponse message, it will decode the transaction and verifies that the ID matches the expected content from the original AppRequest message. If the content matches, the transaction is validated and issued into the mempool.
  • If nodeB's engine decides it isn't likely to receive an AppResponse message, the engine will issue an AppRequestFailure message. In such a case node B will mark the requestID as failed and the request for the unknown transaction is aborted.

Documentation

Overview

Package platformvm is a generated GoMock package.

Index

Constants

View Source 
const (

	// TargetTxSize is the maximum number of bytes a transaction can use to be
	// allowed into the mempool.
	TargetTxSize = 64 * units.KiB

	// TargetBlockSize is maximum number of transaction bytes to place into a
	// StandardBlock
	TargetBlockSize = 128 * units.KiB
)
View Source 
const (
	// CodecVersion is the current default codec version
	CodecVersion = 0
)
View Source 
const (

	// MaxValidatorWeightFactor is the maximum factor of the validator stake
	// that is allowed to be placed on a validator.
	MaxValidatorWeightFactor uint64 = 5
)
View Source 
const MinConnectedStake = .80

MinConnectedStake is the minimum percentage of the Primary Network's that this node must be connected to to be considered healthy

Variables

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

Codecs do serialization and deserialization

Functions

func CanDelegate added in v1.4.5 

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].

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 added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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"`
	Connected          bool          `json:"connected"`
	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 added in v0.8.0 

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      ids.NodeID   `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 APISubnetValidator added in v1.7.11 

type APISubnetValidator struct {
	APIStaker
	// The owner the staking reward, if applicable, will go to
	Connected bool `json:"connected"`
}

APISubnetValidator is the repr. of a subnet validator sent over APIs.

type APIUTXO added in v0.8.0 

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 added in v1.4.5 

type AbortBlock struct {
	DoubleDecisionBlock `serialize:"true"`
	// contains filtered or unexported fields
}

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

func (*AbortBlock) Accept added in v1.6.4 

func (a *AbortBlock) Accept() error

func (*AbortBlock) Verify added in v1.4.5 

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 added in v0.8.0 

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

AddDelegatorArgs are the arguments to AddDelegator

type AddSubnetValidatorArgs added in v0.8.0 

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 added in v0.8.0 

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 added in v1.0.2 

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 added in v0.8.0 

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) InitCtx added in v1.6.0 

func (tx *BaseTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this BaseTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*BaseTx) InputIDs added in v1.6.0 

func (tx *BaseTx) InputIDs() ids.Set

func (*BaseTx) SyntacticVerify added in v1.6.0 

func (tx *BaseTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify 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 added in v1.0.6 

type Client interface {
	// GetHeight returns the current block height of the P Chain
	GetHeight(ctx context.Context, options ...rpc.Option) (uint64, error)
	// ExportKey returns the private key corresponding to [address] from [user]'s account
	ExportKey(ctx context.Context, user api.UserPass, address string, options ...rpc.Option) (string, error)
	// ImportKey imports the specified [privateKey] to [user]'s keystore
	ImportKey(ctx context.Context, user api.UserPass, address string, options ...rpc.Option) (string, error)
	// GetBalance returns the balance of [address] on the P Chain
	GetBalance(ctx context.Context, addrs []string, options ...rpc.Option) (*GetBalanceResponse, error)
	// CreateAddress creates a new address for [user]
	CreateAddress(ctx context.Context, user api.UserPass, options ...rpc.Option) (string, error)
	// ListAddresses returns an array of platform addresses controlled by [user]
	ListAddresses(ctx context.Context, user api.UserPass, options ...rpc.Option) ([]string, error)
	// GetUTXOs returns the byte representation of the UTXOs controlled by [addrs]
	GetUTXOs(
		ctx context.Context,
		addrs []string,
		limit uint32,
		startAddress,
		startUTXOID string,
		options ...rpc.Option,
	) ([][]byte, api.Index, error)
	// GetAtomicUTXOs returns the byte representation of the atomic UTXOs controlled by [addresses]
	// from [sourceChain]
	GetAtomicUTXOs(
		ctx context.Context,
		addrs []string,
		sourceChain string,
		limit uint32,
		startAddress,
		startUTXOID string,
		options ...rpc.Option,
	) ([][]byte, api.Index, error)
	// GetSubnets returns information about the specified subnets
	GetSubnets(context.Context, []ids.ID, ...rpc.Option) ([]APISubnet, error)
	// GetStakingAssetID returns the assetID of the asset used for staking on
	// subnet corresponding to [subnetID]
	GetStakingAssetID(context.Context, ids.ID, ...rpc.Option) (ids.ID, error)
	// GetCurrentValidators returns the list of current validators for subnet with ID [subnetID]
	GetCurrentValidators(ctx context.Context, subnetID ids.ID, nodeIDs []ids.NodeID, options ...rpc.Option) ([]interface{}, error)
	// GetPendingValidators returns the list of pending validators for subnet with ID [subnetID]
	GetPendingValidators(ctx context.Context, subnetID ids.ID, nodeIDs []ids.NodeID, options ...rpc.Option) ([]interface{}, []interface{}, error)
	// GetCurrentSupply returns an upper bound on the supply of AVAX in the system
	GetCurrentSupply(ctx context.Context, options ...rpc.Option) (uint64, error)
	// SampleValidators returns the nodeIDs of a sample of [sampleSize] validators from the current validator set for subnet with ID [subnetID]
	SampleValidators(ctx context.Context, subnetID ids.ID, sampleSize uint16, options ...rpc.Option) ([]ids.NodeID, error)
	// AddValidator issues a transaction to add a validator to the primary network
	// and returns the txID
	AddValidator(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		rewardAddress string,
		nodeID ids.NodeID,
		stakeAmount,
		startTime,
		endTime uint64,
		delegationFeeRate float32,
		options ...rpc.Option,
	) (ids.ID, error)
	// AddDelegator issues a transaction to add a delegator to the primary network
	// and returns the txID
	AddDelegator(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		rewardAddress string,
		nodeID ids.NodeID,
		stakeAmount,
		startTime,
		endTime uint64,
		options ...rpc.Option,
	) (ids.ID, error)
	// AddSubnetValidator issues a transaction to add validator [nodeID] to subnet
	// with ID [subnetID] and returns the txID
	AddSubnetValidator(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		subnetID string,
		nodeID ids.NodeID,
		stakeAmount,
		startTime,
		endTime uint64,
		options ...rpc.Option,
	) (ids.ID, error)
	// CreateSubnet issues a transaction to create [subnet] and returns the txID
	CreateSubnet(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		controlKeys []string,
		threshold uint32,
		options ...rpc.Option,
	) (ids.ID, error)
	// ExportAVAX issues an ExportTx transaction and returns the txID
	ExportAVAX(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		to string,
		amount uint64,
		options ...rpc.Option,
	) (ids.ID, error)
	// ImportAVAX issues an ImportTx transaction and returns the txID
	ImportAVAX(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr,
		to,
		sourceChain string,
		options ...rpc.Option,
	) (ids.ID, error)
	// CreateBlockchain issues a CreateBlockchain transaction and returns the txID
	CreateBlockchain(
		ctx context.Context,
		user api.UserPass,
		from []string,
		changeAddr string,
		subnetID ids.ID,
		vmID string,
		fxIDs []string,
		name string,
		genesisData []byte,
		options ...rpc.Option,
	) (ids.ID, error)
	// GetBlockchainStatus returns the current status of blockchain with ID: [blockchainID]
	GetBlockchainStatus(ctx context.Context, blockchainID string, options ...rpc.Option) (status.BlockchainStatus, error)
	// ValidatedBy returns the ID of the Subnet that validates [blockchainID]
	ValidatedBy(ctx context.Context, blockchainID ids.ID, options ...rpc.Option) (ids.ID, error)
	// Validates returns the list of blockchains that are validated by the subnet with ID [subnetID]
	Validates(ctx context.Context, subnetID ids.ID, options ...rpc.Option) ([]ids.ID, error)
	// GetBlockchains returns the list of blockchains on the platform
	GetBlockchains(ctx context.Context, options ...rpc.Option) ([]APIBlockchain, error)
	// IssueTx issues the transaction and returns its txID
	IssueTx(ctx context.Context, tx []byte, options ...rpc.Option) (ids.ID, error)
	// GetTx returns the byte representation of the transaction corresponding to [txID]
	GetTx(ctx context.Context, txID ids.ID, options ...rpc.Option) ([]byte, error)
	// GetTxStatus returns the status of the transaction corresponding to [txID]
	GetTxStatus(ctx context.Context, txID ids.ID, includeReason bool, options ...rpc.Option) (*GetTxStatusResponse, error)
	// AwaitTxDecided polls [GetTxStatus] until a status is returned that
	// implies the tx may be decided.
	AwaitTxDecided(
		ctx context.Context,
		txID ids.ID,
		includeReason bool,
		freq time.Duration,
		options ...rpc.Option,
	) (*GetTxStatusResponse, error)
	// GetStake returns the amount of nAVAX that [addresses] have cumulatively
	// staked on the Primary Network.
	GetStake(ctx context.Context, addrs []string, options ...rpc.Option) (uint64, [][]byte, error)
	// GetMinStake returns the minimum staking amount in nAVAX for validators
	// and delegators respectively
	GetMinStake(ctx context.Context, options ...rpc.Option) (uint64, uint64, error)
	// GetTotalStake returns the total amount (in nAVAX) staked on the network
	GetTotalStake(ctx context.Context, subnetID ids.ID, options ...rpc.Option) (uint64, error)
	// GetMaxStakeAmount returns the maximum amount of nAVAX staking to the named
	// node during the time period.
	GetMaxStakeAmount(
		ctx context.Context,
		subnetID ids.ID,
		nodeID ids.NodeID,
		startTime uint64,
		endTime uint64,
		options ...rpc.Option,
	) (uint64, error)
	// GetRewardUTXOs returns the reward UTXOs for a transaction
	GetRewardUTXOs(context.Context, *api.GetTxArgs, ...rpc.Option) ([][]byte, error)
	// GetTimestamp returns the current chain timestamp
	GetTimestamp(ctx context.Context, options ...rpc.Option) (time.Time, error)
	// GetValidatorsAt returns the weights of the validator set of a provided subnet
	// at the specified height.
	GetValidatorsAt(ctx context.Context, subnetID ids.ID, height uint64, options ...rpc.Option) (map[ids.NodeID]uint64, error)
	// GetBlock returns the block with the given id.
	GetBlock(ctx context.Context, blockID ids.ID, options ...rpc.Option) ([]byte, error)
}

Client interface for interacting with the P Chain endpoint

func NewClient added in v1.0.6 

func NewClient(uri string) Client

NewClient returns a Client for interacting with the P Chain endpoint

type CommitBlock added in v1.4.5 

type CommitBlock struct {
	DoubleDecisionBlock `serialize:"true"`
	// contains filtered or unexported fields
}

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

func (*CommitBlock) Accept added in v1.6.4 

func (c *CommitBlock) Accept() error

func (*CommitBlock) Verify added in v1.4.5 

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 added in v1.4.5 

func (b *CommonBlock) Accept() error

func (*CommonBlock) Bytes added in v1.4.5 

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

Bytes returns the binary representation of this block

func (*CommonBlock) Height added in v1.4.5 

func (b *CommonBlock) Height() uint64

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

func (*CommonBlock) ID added in v1.4.5 

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

ID returns the ID of this block

func (*CommonBlock) Parent 

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

Parent returns this block's parent's ID

func (*CommonBlock) Reject 

func (b *CommonBlock) Reject() error

func (*CommonBlock) Status added in v1.4.5 

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

Status returns the status of this block

func (*CommonBlock) Timestamp added in v1.5.3 

func (b *CommonBlock) Timestamp() time.Time

Timestamp returns this block's time.

func (*CommonBlock) Verify added in v1.2.2 

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 added in v1.4.5 

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 added in v0.8.0 

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

DoubleDecisionBlock contains the accept for a pair of blocks

func (*DoubleDecisionBlock) Accept added in v0.8.0 

func (ddb *DoubleDecisionBlock) Accept() error

type ExportAVAXArgs added in v0.8.0 

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 added in v0.8.0 

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

ExportKeyArgs are arguments for ExportKey

type ExportKeyReply added in v0.8.0 

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 {
	config.Config
}

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 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

type GenesisUTXO added in v1.0.0 

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

GenesisUTXO adds messages to UTXOs

type GetBalanceRequest added in v1.7.4 

type GetBalanceRequest struct {
	// TODO: remove Address
	Address   *string  `json:"address,omitempty"`
	Addresses []string `json:"addresses"`
}

type GetBalanceResponse added in v0.8.0 

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"`
}

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.BlockchainStatus `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 added in v0.8.0 

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 []ids.NodeID `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 added in v0.8.0 

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

type GetMaxStakeAmountArgs added in v1.0.0 

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

GetMaxStakeAmountArgs is the request for calling GetMaxStakeAmount.

type GetMaxStakeAmountReply added in v1.0.0 

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

GetMaxStakeAmountReply is the response from calling GetMaxStakeAmount.

type GetMinStakeReply added in v0.8.0 

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 []ids.NodeID `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 added in v1.4.5 

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 added in v1.2.1 

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

type GetStakeReply added in v0.8.0 

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 added in v0.8.0 

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

GetStakingAssetIDArgs are the arguments to GetStakingAssetID

type GetStakingAssetIDResponse added in v0.8.0 

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 GetTimestampReply added in v1.5.1 

type GetTimestampReply struct {
	// Current timestamp
	Timestamp time.Time `json:"timestamp"`
}

GetTimestampReply is the response from GetTimestamp

type GetTotalStakeArgs added in v1.7.11 

type GetTotalStakeArgs struct {
	// Subnet we're getting the total stake
	// If omitted returns Primary network weight
	SubnetID ids.ID `json:"subnetID"`
}

GetTotalStakeArgs are the arguments for calling GetTotalStake

type GetTotalStakeReply added in v1.0.6 

type GetTotalStakeReply struct {
	Stake  json.Uint64 `json:"stake,omitempty"`
	Weight json.Uint64 `json:"weight,omitempty"`
}

GetTotalStakeReply is the response from calling GetTotalStake.

type GetTxStatusArgs added in v0.8.0 

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"`
}

type GetTxStatusResponse added in v1.0.4 

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

type GetUTXOsArgs added in v0.8.0 

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 added in v0.8.0 

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 GetValidatorsAtArgs added in v1.5.3 

type GetValidatorsAtArgs struct {
	Height   json.Uint64 `json:"height"`
	SubnetID ids.ID      `json:"subnetID"`
}

GetValidatorsAtArgs is the response from GetValidatorsAt

type GetValidatorsAtReply added in v1.5.3 

type GetValidatorsAtReply struct {
	Validators map[ids.NodeID]uint64 `json:"validators"`
}

GetValidatorsAtReply is the response from GetValidatorsAt

type ImportAVAXArgs added in v0.8.0 

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 added in v0.8.0 

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

ImportKeyArgs are arguments for ImportKey

type Index added in v0.8.0 

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 added in v1.4.5 

type InternalState interface {
	MutableState
	uptime.State
	avax.UTXOReader

	SetHeight(height uint64)

	AddCurrentStaker(tx *Tx, potentialReward uint64)
	DeleteCurrentStaker(tx *Tx)
	GetValidatorWeightDiffs(height uint64, subnetID ids.ID) (map[ids.NodeID]*ValidatorWeightDiff, error)

	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)

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

func NewInternalState added in v1.4.5 

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

func NewMeteredInternalState added in v1.4.5 

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

type Mempool added in v1.0.2 

type Mempool interface {
	Add(tx *Tx) error
	Has(txID ids.ID) bool
	Get(txID ids.ID) *Tx

	AddDecisionTx(tx *Tx)
	AddProposalTx(tx *Tx)

	HasDecisionTxs() bool
	HasProposalTx() bool

	RemoveDecisionTxs(txs []*Tx)
	RemoveProposalTx(tx *Tx)

	PopDecisionTxs(maxTxsBytes int) []*Tx
	PopProposalTx() *Tx

	MarkDropped(txID ids.ID)
	WasDropped(txID ids.ID) bool
}

func NewMempool added in v1.6.0 

func NewMempool(namespace string, registerer prometheus.Registerer) (Mempool, error)

type MockInternalState added in v1.7.6 

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

MockInternalState is a mock of InternalState interface.

func NewMockInternalState added in v1.7.6 

func NewMockInternalState(ctrl *gomock.Controller) *MockInternalState

NewMockInternalState creates a new mock instance.

func (*MockInternalState) Abort added in v1.7.6 

func (m *MockInternalState) Abort()

Abort mocks base method.

func (*MockInternalState) AddBlock added in v1.7.6 

func (m *MockInternalState) AddBlock(block Block)

AddBlock mocks base method.

func (*MockInternalState) AddChain added in v1.7.6 

func (m *MockInternalState) AddChain(createChainTx *Tx)

AddChain mocks base method.

func (*MockInternalState) AddCurrentStaker added in v1.7.6 

func (m *MockInternalState) AddCurrentStaker(tx *Tx, potentialReward uint64)

AddCurrentStaker mocks base method.

func (*MockInternalState) AddPendingStaker added in v1.7.6 

func (m *MockInternalState) AddPendingStaker(tx *Tx)

AddPendingStaker mocks base method.

func (*MockInternalState) AddRewardUTXO added in v1.7.6 

func (m *MockInternalState) AddRewardUTXO(txID ids.ID, utxo *avax.UTXO)

AddRewardUTXO mocks base method.

func (*MockInternalState) AddSubnet added in v1.7.6 

func (m *MockInternalState) AddSubnet(createSubnetTx *Tx)

AddSubnet mocks base method.

func (*MockInternalState) AddTx added in v1.7.6 

func (m *MockInternalState) AddTx(tx *Tx, status status.Status)

AddTx mocks base method.

func (*MockInternalState) AddUTXO added in v1.7.6 

func (m *MockInternalState) AddUTXO(utxo *avax.UTXO)

AddUTXO mocks base method.

func (*MockInternalState) Close added in v1.7.6 

func (m *MockInternalState) Close() error

Close mocks base method.

func (*MockInternalState) Commit added in v1.7.6 

func (m *MockInternalState) Commit() error

Commit mocks base method.

func (*MockInternalState) CommitBatch added in v1.7.6 

func (m *MockInternalState) CommitBatch() (database.Batch, error)

CommitBatch mocks base method.

func (*MockInternalState) CurrentStakerChainState added in v1.7.6 

func (m *MockInternalState) CurrentStakerChainState() currentStakerChainState

CurrentStakerChainState mocks base method.

func (*MockInternalState) DeleteCurrentStaker added in v1.7.6 

func (m *MockInternalState) DeleteCurrentStaker(tx *Tx)

DeleteCurrentStaker mocks base method.

func (*MockInternalState) DeletePendingStaker added in v1.7.6 

func (m *MockInternalState) DeletePendingStaker(tx *Tx)

DeletePendingStaker mocks base method.

func (*MockInternalState) DeleteUTXO added in v1.7.6 

func (m *MockInternalState) DeleteUTXO(utxoID ids.ID)

DeleteUTXO mocks base method.

func (*MockInternalState) EXPECT added in v1.7.6 

func (m *MockInternalState) EXPECT() *MockInternalStateMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockInternalState) GetBlock added in v1.7.6 

func (m *MockInternalState) GetBlock(blockID ids.ID) (Block, error)

GetBlock mocks base method.

func (*MockInternalState) GetChains added in v1.7.6 

func (m *MockInternalState) GetChains(subnetID ids.ID) ([]*Tx, error)

GetChains mocks base method.

func (*MockInternalState) GetCurrentSupply added in v1.7.6 

func (m *MockInternalState) GetCurrentSupply() uint64

GetCurrentSupply mocks base method.

func (*MockInternalState) GetLastAccepted added in v1.7.6 

func (m *MockInternalState) GetLastAccepted() ids.ID

GetLastAccepted mocks base method.

func (*MockInternalState) GetRewardUTXOs added in v1.7.6 

func (m *MockInternalState) GetRewardUTXOs(txID ids.ID) ([]*avax.UTXO, error)

GetRewardUTXOs mocks base method.

func (*MockInternalState) GetStartTime added in v1.7.6 

func (m *MockInternalState) GetStartTime(nodeID ids.NodeID) (time.Time, error)

GetStartTime mocks base method.

func (*MockInternalState) GetSubnets added in v1.7.6 

func (m *MockInternalState) GetSubnets() ([]*Tx, error)

GetSubnets mocks base method.

func (*MockInternalState) GetTimestamp added in v1.7.6 

func (m *MockInternalState) GetTimestamp() time.Time

GetTimestamp mocks base method.

func (*MockInternalState) GetTx added in v1.7.6 

func (m *MockInternalState) GetTx(txID ids.ID) (*Tx, status.Status, error)

GetTx mocks base method.

func (*MockInternalState) GetUTXO added in v1.7.6 

func (m *MockInternalState) GetUTXO(utxoID ids.ID) (*avax.UTXO, error)

GetUTXO mocks base method.

func (*MockInternalState) GetUptime added in v1.7.6 

func (m *MockInternalState) GetUptime(nodeID ids.NodeID) (time.Duration, time.Time, error)

GetUptime mocks base method.

func (*MockInternalState) GetValidatorWeightDiffs added in v1.7.6 

func (m *MockInternalState) GetValidatorWeightDiffs(height uint64, subnetID ids.ID) (map[ids.NodeID]*ValidatorWeightDiff, error)

GetValidatorWeightDiffs mocks base method.

func (*MockInternalState) PendingStakerChainState added in v1.7.6 

func (m *MockInternalState) PendingStakerChainState() pendingStakerChainState

PendingStakerChainState mocks base method.

func (*MockInternalState) SetCurrentStakerChainState added in v1.7.6 

func (m *MockInternalState) SetCurrentStakerChainState(arg0 currentStakerChainState)

SetCurrentStakerChainState mocks base method.

func (*MockInternalState) SetCurrentSupply added in v1.7.6 

func (m *MockInternalState) SetCurrentSupply(arg0 uint64)

SetCurrentSupply mocks base method.

func (*MockInternalState) SetHeight added in v1.7.6 

func (m *MockInternalState) SetHeight(height uint64)

SetHeight mocks base method.

func (*MockInternalState) SetLastAccepted added in v1.7.6 

func (m *MockInternalState) SetLastAccepted(arg0 ids.ID)

SetLastAccepted mocks base method.

func (*MockInternalState) SetPendingStakerChainState added in v1.7.6 

func (m *MockInternalState) SetPendingStakerChainState(arg0 pendingStakerChainState)

SetPendingStakerChainState mocks base method.

func (*MockInternalState) SetTimestamp added in v1.7.6 

func (m *MockInternalState) SetTimestamp(arg0 time.Time)

SetTimestamp mocks base method.

func (*MockInternalState) SetUptime added in v1.7.6 

func (m *MockInternalState) SetUptime(nodeID ids.NodeID, upDuration time.Duration, lastUpdated time.Time) error

SetUptime mocks base method.

func (*MockInternalState) UTXOIDs added in v1.7.6 

func (m *MockInternalState) UTXOIDs(addr []byte, previous ids.ID, limit int) ([]ids.ID, error)

UTXOIDs mocks base method.

type MockInternalStateMockRecorder added in v1.7.6 

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

MockInternalStateMockRecorder is the mock recorder for MockInternalState.

func (*MockInternalStateMockRecorder) Abort added in v1.7.6 

func (mr *MockInternalStateMockRecorder) Abort() *gomock.Call

Abort indicates an expected call of Abort.

func (*MockInternalStateMockRecorder) AddBlock added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddBlock(block interface{}) *gomock.Call

AddBlock indicates an expected call of AddBlock.

func (*MockInternalStateMockRecorder) AddChain added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddChain(createChainTx interface{}) *gomock.Call

AddChain indicates an expected call of AddChain.

func (*MockInternalStateMockRecorder) AddCurrentStaker added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddCurrentStaker(tx, potentialReward interface{}) *gomock.Call

AddCurrentStaker indicates an expected call of AddCurrentStaker.

func (*MockInternalStateMockRecorder) AddPendingStaker added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddPendingStaker(tx interface{}) *gomock.Call

AddPendingStaker indicates an expected call of AddPendingStaker.

func (*MockInternalStateMockRecorder) AddRewardUTXO added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddRewardUTXO(txID, utxo interface{}) *gomock.Call

AddRewardUTXO indicates an expected call of AddRewardUTXO.

func (*MockInternalStateMockRecorder) AddSubnet added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddSubnet(createSubnetTx interface{}) *gomock.Call

AddSubnet indicates an expected call of AddSubnet.

func (*MockInternalStateMockRecorder) AddTx added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddTx(tx, status interface{}) *gomock.Call

AddTx indicates an expected call of AddTx.

func (*MockInternalStateMockRecorder) AddUTXO added in v1.7.6 

func (mr *MockInternalStateMockRecorder) AddUTXO(utxo interface{}) *gomock.Call

AddUTXO indicates an expected call of AddUTXO.

func (*MockInternalStateMockRecorder) Close added in v1.7.6 

func (mr *MockInternalStateMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close.

func (*MockInternalStateMockRecorder) Commit added in v1.7.6 

func (mr *MockInternalStateMockRecorder) Commit() *gomock.Call

Commit indicates an expected call of Commit.

func (*MockInternalStateMockRecorder) CommitBatch added in v1.7.6 

func (mr *MockInternalStateMockRecorder) CommitBatch() *gomock.Call

CommitBatch indicates an expected call of CommitBatch.

func (*MockInternalStateMockRecorder) CurrentStakerChainState added in v1.7.6 

func (mr *MockInternalStateMockRecorder) CurrentStakerChainState() *gomock.Call

CurrentStakerChainState indicates an expected call of CurrentStakerChainState.

func (*MockInternalStateMockRecorder) DeleteCurrentStaker added in v1.7.6 

func (mr *MockInternalStateMockRecorder) DeleteCurrentStaker(tx interface{}) *gomock.Call

DeleteCurrentStaker indicates an expected call of DeleteCurrentStaker.

func (*MockInternalStateMockRecorder) DeletePendingStaker added in v1.7.6 

func (mr *MockInternalStateMockRecorder) DeletePendingStaker(tx interface{}) *gomock.Call

DeletePendingStaker indicates an expected call of DeletePendingStaker.

func (*MockInternalStateMockRecorder) DeleteUTXO added in v1.7.6 

func (mr *MockInternalStateMockRecorder) DeleteUTXO(utxoID interface{}) *gomock.Call

DeleteUTXO indicates an expected call of DeleteUTXO.

func (*MockInternalStateMockRecorder) GetBlock added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetBlock(blockID interface{}) *gomock.Call

GetBlock indicates an expected call of GetBlock.

func (*MockInternalStateMockRecorder) GetChains added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetChains(subnetID interface{}) *gomock.Call

GetChains indicates an expected call of GetChains.

func (*MockInternalStateMockRecorder) GetCurrentSupply added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetCurrentSupply() *gomock.Call

GetCurrentSupply indicates an expected call of GetCurrentSupply.

func (*MockInternalStateMockRecorder) GetLastAccepted added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetLastAccepted() *gomock.Call

GetLastAccepted indicates an expected call of GetLastAccepted.

func (*MockInternalStateMockRecorder) GetRewardUTXOs added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetRewardUTXOs(txID interface{}) *gomock.Call

GetRewardUTXOs indicates an expected call of GetRewardUTXOs.

func (*MockInternalStateMockRecorder) GetStartTime added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetStartTime(nodeID interface{}) *gomock.Call

GetStartTime indicates an expected call of GetStartTime.

func (*MockInternalStateMockRecorder) GetSubnets added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetSubnets() *gomock.Call

GetSubnets indicates an expected call of GetSubnets.

func (*MockInternalStateMockRecorder) GetTimestamp added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetTimestamp() *gomock.Call

GetTimestamp indicates an expected call of GetTimestamp.

func (*MockInternalStateMockRecorder) GetTx added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetTx(txID interface{}) *gomock.Call

GetTx indicates an expected call of GetTx.

func (*MockInternalStateMockRecorder) GetUTXO added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetUTXO(utxoID interface{}) *gomock.Call

GetUTXO indicates an expected call of GetUTXO.

func (*MockInternalStateMockRecorder) GetUptime added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetUptime(nodeID interface{}) *gomock.Call

GetUptime indicates an expected call of GetUptime.

func (*MockInternalStateMockRecorder) GetValidatorWeightDiffs added in v1.7.6 

func (mr *MockInternalStateMockRecorder) GetValidatorWeightDiffs(height, subnetID interface{}) *gomock.Call

GetValidatorWeightDiffs indicates an expected call of GetValidatorWeightDiffs.

func (*MockInternalStateMockRecorder) PendingStakerChainState added in v1.7.6 

func (mr *MockInternalStateMockRecorder) PendingStakerChainState() *gomock.Call

PendingStakerChainState indicates an expected call of PendingStakerChainState.

func (*MockInternalStateMockRecorder) SetCurrentStakerChainState added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetCurrentStakerChainState(arg0 interface{}) *gomock.Call

SetCurrentStakerChainState indicates an expected call of SetCurrentStakerChainState.

func (*MockInternalStateMockRecorder) SetCurrentSupply added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetCurrentSupply(arg0 interface{}) *gomock.Call

SetCurrentSupply indicates an expected call of SetCurrentSupply.

func (*MockInternalStateMockRecorder) SetHeight added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetHeight(height interface{}) *gomock.Call

SetHeight indicates an expected call of SetHeight.

func (*MockInternalStateMockRecorder) SetLastAccepted added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetLastAccepted(arg0 interface{}) *gomock.Call

SetLastAccepted indicates an expected call of SetLastAccepted.

func (*MockInternalStateMockRecorder) SetPendingStakerChainState added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetPendingStakerChainState(arg0 interface{}) *gomock.Call

SetPendingStakerChainState indicates an expected call of SetPendingStakerChainState.

func (*MockInternalStateMockRecorder) SetTimestamp added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetTimestamp(arg0 interface{}) *gomock.Call

SetTimestamp indicates an expected call of SetTimestamp.

func (*MockInternalStateMockRecorder) SetUptime added in v1.7.6 

func (mr *MockInternalStateMockRecorder) SetUptime(nodeID, upDuration, lastUpdated interface{}) *gomock.Call

SetUptime indicates an expected call of SetUptime.

func (*MockInternalStateMockRecorder) UTXOIDs added in v1.7.6 

func (mr *MockInternalStateMockRecorder) UTXOIDs(addr, previous, limit interface{}) *gomock.Call

UTXOIDs indicates an expected call of UTXOIDs.

type MutableState added in v1.4.5 

type MutableState interface {
	UTXOState
	ValidatorState

	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.Status, error)
	AddTx(tx *Tx, status status.Status)
}

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 added in v0.8.0 

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 added in v1.0.2 

func (pb *ProposalBlock) Reject() error

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 []ids.NodeID `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 added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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

ExportKey returns a private key from the provided user

func (*Service) GetBalance added in v0.8.0 

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

GetBalance gets the balance of an address

func (*Service) GetBlock added in v1.7.6 

func (service *Service) GetBlock(_ *http.Request, args *api.GetBlockArgs, response *api.GetBlockResponse) error

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 added in v0.8.0 

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 added in v0.8.0 

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

GetHeight returns the height of the last accepted block

func (*Service) GetMaxStakeAmount added in v1.0.0 

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 added in v0.8.0 

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 added in v1.4.5 

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 added in v0.8.0 

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 added in v0.8.0 

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) GetTimestamp added in v1.5.1 

func (service *Service) GetTimestamp(_ *http.Request, args *struct{}, reply *GetTimestampReply) error

GetTimestamp returns the current timestamp on chain.

func (*Service) GetTotalStake added in v1.0.3 

func (service *Service) GetTotalStake(_ *http.Request, args *GetTotalStakeArgs, reply *GetTotalStakeReply) error

GetTotalStake returns the total amount staked on the Primary Network

func (*Service) GetTx added in v0.8.0 

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

GetTx gets a tx

func (*Service) GetTxStatus added in v0.8.0 

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

GetTxStatus gets a tx's status

func (*Service) GetUTXOs added in v0.8.0 

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

GetUTXOs returns the UTXOs controlled by the given addresses

func (*Service) GetValidatorsAt added in v1.5.3 

func (service *Service) GetValidatorsAt(_ *http.Request, args *GetValidatorsAtArgs, reply *GetValidatorsAtReply) error

GetValidatorsAt returns the weights of the validator set of a provided subnet at the specified height.

func (*Service) ImportAVAX added in v0.8.0 

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 added in v0.8.0 

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 added in v0.8.0 

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 StandardBlock 

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

	Txs []*Tx `serialize:"true" json:"txs"`
	// contains filtered or unexported fields
}

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

func (*StandardBlock) Accept added in v1.7.0 

func (sb *StandardBlock) Accept() error

func (*StandardBlock) Reject added in v1.0.2 

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 StaticClient added in v1.7.10 

type StaticClient interface {
	BuildGenesis(ctx context.Context, args *BuildGenesisArgs, options ...rpc.Option) (*BuildGenesisReply, error)
}

StaticClient for interacting with the platformvm static api

func NewStaticClient added in v1.7.10 

func NewStaticClient(uri string) StaticClient

NewClient returns a platformvm client for interacting with the platformvm static api

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 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 TimedTx 

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

type TimedTxHeap added in v1.6.0 

type TimedTxHeap interface {
	TxHeap

	Timestamp() time.Time
}

func NewTxHeapByStartTime added in v1.6.0 

func NewTxHeapByStartTime() TimedTxHeap

type Tx added in v0.8.0 

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 added in v0.8.0 

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

Sign this transaction with the provided signers

type TxHeap added in v1.6.0 

type TxHeap interface {
	Add(tx *Tx)
	Get(txID ids.ID) *Tx
	Remove(txID ids.ID) *Tx
	Peek() *Tx
	RemoveTop() *Tx
	Len() int
}

func NewTxHeapByAge added in v1.6.0 

func NewTxHeapByAge() TxHeap

func NewTxHeapWithMetrics added in v1.6.2 

func NewTxHeapWithMetrics(
	txHeap TxHeap,
	namespace string,
	registerer prometheus.Registerer,
) (TxHeap, error)

type UTXOAdder added in v1.4.5 

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

type UTXODeleter added in v1.4.5 

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

type UTXOGetter added in v1.4.5 

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

type UTXOState added in v1.4.5 

type UTXOState interface {
	UTXOGetter
	UTXOAdder
	UTXODeleter
}

type UnsignedAddDelegatorTx added in v0.8.0 

type UnsignedAddDelegatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// Describes the delegatee
	Validator pChainValidator.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 fx.Owner `serialize:"true" json:"rewardsOwner"`
}

UnsignedAddDelegatorTx is an unsigned addDelegatorTx

func (*UnsignedAddDelegatorTx) EndTime added in v0.8.0 

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

EndTime of this validator

func (*UnsignedAddDelegatorTx) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedAddDelegatorTx) InitCtx added in v1.6.0 

func (tx *UnsignedAddDelegatorTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this UnsignedAddDelegatorTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*UnsignedAddDelegatorTx) InitiallyPrefersCommit added in v0.8.0 

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 added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedAddDelegatorTx) StartTime added in v0.8.0 

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

StartTime of this validator

func (*UnsignedAddDelegatorTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedAddDelegatorTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify returns nil iff [tx] is valid

func (*UnsignedAddDelegatorTx) Weight added in v1.0.0 

func (tx *UnsignedAddDelegatorTx) Weight() uint64

Weight of this validator

type UnsignedAddSubnetValidatorTx added in v0.8.0 

type UnsignedAddSubnetValidatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// The validator
	Validator pChainValidator.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 added in v0.8.0 

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

EndTime of this validator

func (*UnsignedAddSubnetValidatorTx) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedAddSubnetValidatorTx) InitiallyPrefersCommit added in v0.8.0 

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 added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedAddSubnetValidatorTx) StartTime added in v0.8.0 

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

StartTime of this validator

func (*UnsignedAddSubnetValidatorTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedAddSubnetValidatorTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify returns nil iff [tx] is valid

func (*UnsignedAddSubnetValidatorTx) Weight added in v1.0.0 

func (tx *UnsignedAddSubnetValidatorTx) Weight() uint64

Weight of this validator

type UnsignedAddValidatorTx added in v0.8.0 

type UnsignedAddValidatorTx struct {
	// Metadata, inputs and outputs
	BaseTx `serialize:"true"`
	// Describes the delegatee
	Validator pChainValidator.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 fx.Owner `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 added in v0.8.0 

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

EndTime of this validator

func (*UnsignedAddValidatorTx) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedAddValidatorTx) InitCtx added in v1.6.0 

func (tx *UnsignedAddValidatorTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this UnsignedAddValidatorTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*UnsignedAddValidatorTx) InitiallyPrefersCommit added in v0.8.0 

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 added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedAddValidatorTx) StartTime added in v0.8.0 

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

StartTime of this validator

func (*UnsignedAddValidatorTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedAddValidatorTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify returns nil iff [tx] is valid

func (*UnsignedAddValidatorTx) Weight added in v1.0.0 

func (tx *UnsignedAddValidatorTx) Weight() uint64

Weight of this validator

type UnsignedAdvanceTimeTx added in v0.8.0 

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) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedAdvanceTimeTx) InitCtx added in v1.6.0 

func (tx *UnsignedAdvanceTimeTx) InitCtx(*snow.Context)

func (*UnsignedAdvanceTimeTx) InitiallyPrefersCommit added in v0.8.0 

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) InputIDs added in v1.6.0 

func (tx *UnsignedAdvanceTimeTx) InputIDs() ids.Set

func (*UnsignedAdvanceTimeTx) SemanticVerify added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedAdvanceTimeTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedAdvanceTimeTx) SyntacticVerify(*snow.Context) error

func (*UnsignedAdvanceTimeTx) Timestamp added in v0.8.0 

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

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

type UnsignedAtomicTx added in v0.8.0 

type UnsignedAtomicTx interface {
	UnsignedDecisionTx

	// Execute this transaction with the provided state.
	AtomicExecute(vm *VM, parentState MutableState, stx *Tx) (VersionedState, error)

	// Accept this transaction with the additionally provided state transitions.
	AtomicAccept(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"`
	// Authorizes this blockchain to be added to this subnet
	SubnetAuth verify.Verifiable `serialize:"true" json:"subnetAuthorization"`
}

UnsignedCreateChainTx is an unsigned CreateChainTx

func (*UnsignedCreateChainTx) AtomicOperations added in v1.7.0 

func (tx *UnsignedCreateChainTx) AtomicOperations() (ids.ID, *atomic.Requests, error)

func (*UnsignedCreateChainTx) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedCreateChainTx) InputUTXOs added in v1.7.0 

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

func (*UnsignedCreateChainTx) SemanticVerify added in v0.8.0 

func (tx *UnsignedCreateChainTx) SemanticVerify(vm *VM, parentState MutableState, stx *Tx) error

Attempts to verify this transaction with the provided state.

func (*UnsignedCreateChainTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedCreateChainTx) SyntacticVerify(ctx *snow.Context) error

type UnsignedCreateSubnetTx 

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

UnsignedCreateSubnetTx is an unsigned proposal to create a new subnet

func (*UnsignedCreateSubnetTx) AtomicOperations added in v1.7.0 

func (tx *UnsignedCreateSubnetTx) AtomicOperations() (ids.ID, *atomic.Requests, error)

func (*UnsignedCreateSubnetTx) Execute added in v1.6.0 

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

Execute this transaction.

func (*UnsignedCreateSubnetTx) InitCtx added in v1.6.0 

func (tx *UnsignedCreateSubnetTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this UnsignedCreateSubnetTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*UnsignedCreateSubnetTx) InputUTXOs added in v1.7.0 

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

InputUTXOs for [DecisionTxs] will return an empty set to diffrentiate from the [AtomicTxs] input UTXOs

func (*UnsignedCreateSubnetTx) SemanticVerify added in v0.8.0 

func (tx *UnsignedCreateSubnetTx) SemanticVerify(vm *VM, parentState MutableState, stx *Tx) error

Attempts to verify this transaction with the provided state.

func (*UnsignedCreateSubnetTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedCreateSubnetTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify verifies that this transaction is well-formed

type UnsignedDecisionTx added in v0.8.0 

type UnsignedDecisionTx interface {
	UnsignedTx

	// Execute this transaction with the provided state.
	Execute(vm *VM, vs VersionedState, stx *Tx) (
		onAcceptFunc func() error,
		err error,
	)

	// To maintain consistency with the Atomic txs
	InputUTXOs() ids.Set

	// AtomicOperations provides the requests to be written to shared memory.
	AtomicOperations() (ids.ID, *atomic.Requests, error)
}

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) AtomicAccept added in v1.7.0 

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

Accept this transaction.

func (*UnsignedExportTx) AtomicExecute added in v1.7.0 

func (tx *UnsignedExportTx) AtomicExecute(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (VersionedState, error)

Execute this transaction and return the versioned state.

func (*UnsignedExportTx) AtomicOperations added in v1.7.0 

func (tx *UnsignedExportTx) AtomicOperations() (ids.ID, *atomic.Requests, error)

AtomicOperations returns the shared memory requests

func (*UnsignedExportTx) Execute added in v1.6.0 

func (tx *UnsignedExportTx) Execute(
	vm *VM,
	vs VersionedState,
	stx *Tx,
) (func() error, error)

Execute this transaction.

func (*UnsignedExportTx) InitCtx added in v1.6.0 

func (tx *UnsignedExportTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this UnsignedExportTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*UnsignedExportTx) InputUTXOs added in v0.8.0 

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

InputUTXOs returns an empty set

func (*UnsignedExportTx) SemanticVerify added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedExportTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedExportTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify 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) AtomicAccept added in v1.7.0 

func (tx *UnsignedImportTx) AtomicAccept(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) AtomicExecute added in v1.7.0 

func (tx *UnsignedImportTx) AtomicExecute(
	vm *VM,
	parentState MutableState,
	stx *Tx,
) (VersionedState, error)

[AtomicExecute] to maintain consistency for the standard block.

func (*UnsignedImportTx) AtomicOperations added in v1.7.0 

func (tx *UnsignedImportTx) AtomicOperations() (ids.ID, *atomic.Requests, error)

AtomicOperations returns the shared memory requests

func (*UnsignedImportTx) Execute added in v1.6.0 

func (tx *UnsignedImportTx) Execute(
	vm *VM,
	vs VersionedState,
	stx *Tx,
) (func() error, error)

Execute this transaction.

func (*UnsignedImportTx) InitCtx added in v1.6.0 

func (tx *UnsignedImportTx) InitCtx(ctx *snow.Context)

InitCtx sets the FxID fields in the inputs and outputs of this UnsignedImportTx. Also sets the [ctx] to the given [vm.ctx] so that the addresses can be json marshalled into human readable format

func (*UnsignedImportTx) InputIDs added in v1.6.0 

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

func (*UnsignedImportTx) InputUTXOs added in v0.8.0 

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

InputUTXOs returns the UTXOIDs of the imported funds

func (*UnsignedImportTx) SemanticVerify added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedImportTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedImportTx) SyntacticVerify(ctx *snow.Context) error

SyntacticVerify this transaction is well-formed

type UnsignedProposalTx added in v0.8.0 

type UnsignedProposalTx interface {
	UnsignedTx

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

UnsignedProposalTx is an unsigned operation that can be proposed

type UnsignedRewardValidatorTx added in v0.8.0 

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) Execute added in v1.6.0 

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

Execute this transaction.

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.

func (*UnsignedRewardValidatorTx) InitCtx added in v1.6.0 

func (tx *UnsignedRewardValidatorTx) InitCtx(*snow.Context)

func (*UnsignedRewardValidatorTx) InitiallyPrefersCommit added in v0.8.0 

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) InputIDs added in v1.6.0 

func (tx *UnsignedRewardValidatorTx) InputIDs() ids.Set

func (*UnsignedRewardValidatorTx) SemanticVerify added in v0.8.0 

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

Attempts to verify this transaction with the provided state.

func (*UnsignedRewardValidatorTx) SyntacticVerify added in v1.6.0 

func (tx *UnsignedRewardValidatorTx) SyntacticVerify(*snow.Context) error

type UnsignedTx added in v0.8.0 

type UnsignedTx interface {
	// TODO: Remove this initialization pattern from both the platformvm and the
	// avm.
	snow.ContextInitializable
	Initialize(unsignedBytes, signedBytes []byte)
	ID() ids.ID
	UnsignedBytes() []byte
	Bytes() []byte

	// InputIDs returns the set of inputs this transaction consumes
	InputIDs() ids.Set

	// Attempts to verify this transaction without any provided state.
	SyntacticVerify(ctx *snow.Context) error

	// Attempts to verify this transaction with the provided state.
	SemanticVerify(vm *VM, parentState MutableState, stx *Tx) error
}

UnsignedTx is an unsigned transaction

type VM 

type VM struct {
	Factory

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

func (*VM) AcceptBlock added in v1.4.5 

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

func (*VM) AcceptTx added in v1.4.5 

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

func (VM) AppGossip added in v1.5.3 

func (n VM) AppGossip(nodeID ids.NodeID, msgBytes []byte) error

func (VM) AppRequest added in v1.5.3 

func (n VM) AppRequest(nodeID ids.NodeID, requestID uint32, deadline time.Time, msgBytes []byte) error

func (VM) AppRequestFailed added in v1.5.3 

func (n VM) AppRequestFailed(nodeID ids.NodeID, requestID uint32) error

func (VM) AppResponse added in v1.5.3 

func (n VM) AppResponse(nodeID ids.NodeID, requestID uint32, msgBytes []byte) error

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() *mockable.Clock

func (*VM) CodecRegistry added in v1.0.6 

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

func (*VM) Connected added in v0.8.0 

func (vm *VM) Connected(vdrID ids.NodeID, _ version.Application) error

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 added in v0.8.0 

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

func (*VM) GetBlock 

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

func (*VM) GetCurrentHeight added in v1.6.0 

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

GetCurrentHeight returns the height of the last accepted block

func (*VM) GetMinimumHeight added in v1.7.10 

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

GetMinimumHeight returns the height of the most recent block beyond the horizon of our recentlyAccepted window.

Because the time between blocks is arbitrary, we're only guaranteed that the window's configured TTL amount of time has passed once an element expires from the window.

To try to always return a block older than the window's TTL, we return the parent of the oldest element in the window (as an expired element is always guaranteed to be sufficiently stale). If we haven't expired an element yet in the case of a process restart, we default to the lastAccepted block's height which is likely (but not guaranteed) to also be older than the window's configured TTL.

func (*VM) GetValidatorSet added in v1.5.3 

func (vm *VM) GetValidatorSet(height uint64, subnetID ids.ID) (map[ids.NodeID]uint64, error)

GetValidatorSet returns the validator set at the specified height for the provided subnetID.

func (VM) GossipTx added in v1.6.0 

func (n VM) GossipTx(tx *Tx) error

func (*VM) HealthCheck added in v1.2.1 

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

func (*VM) Initialize 

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

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

func (*VM) LastAccepted added in v1.4.5 

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) ParseBlock 

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

func (*VM) Preferred added in v1.4.5 

func (vm *VM) Preferred() (Block, 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) SetState added in v1.7.5 

func (vm *VM) SetState(state snow.State) error

func (*VM) Shutdown 

func (vm *VM) Shutdown() error

Shutdown this blockchain

func (*VM) Version added in v1.4.10 

func (vm *VM) Version() (string, error)

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 ValidatorState added in v1.5.3 

type ValidatorState interface {
	CurrentStakerChainState() currentStakerChainState
	PendingStakerChainState() pendingStakerChainState
}

type ValidatorWeightDiff added in v1.5.3 

type ValidatorWeightDiff struct {
	Decrease bool   `serialize:"true"`
	Amount   uint64 `serialize:"true"`
}

type VersionedState added in v1.4.5 

type VersionedState interface {
	MutableState

	SetBase(MutableState)
	Apply(InternalState)
}

Source Files

View all Source files

Directories

Path Synopsis
Package fx is a generated GoMock package.
 Package fx is a generated GoMock package.

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.