api

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 19, 2026 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProposedHeightJSON = `"proposed"`
	ProposedHeight     = math.MaxUint64
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIL1Validator

type APIL1Validator struct {
	NodeID    ids.NodeID   `json:"nodeID"`
	StartTime json.Uint64  `json:"startTime"`
	Weight    json.Uint64  `json:"weight"`
	Balance   *json.Uint64 `json:"balance,omitempty"`
	BaseL1Validator
}

APIL1Validator is the representation of an L1 validator sent via RPC.

type BaseL1Validator

type BaseL1Validator struct {
	ValidationID          *ids.ID              `json:"validationID,omitempty"`
	PublicKey             *types.JSONByteSlice `json:"publicKey,omitempty"`
	RemainingBalanceOwner *Owner               `json:"remainingBalanceOwner,omitempty"`
	DeactivationOwner     *Owner               `json:"deactivationOwner,omitempty"`
	MinNonce              *json.Uint64         `json:"minNonce,omitempty"`
}

BaseL1Validator contains the shared fields for L1 validators.

type Delegator

type Delegator struct {
	Staker
	RewardOwner     *Owner       `json:"rewardOwner,omitempty"`
	PotentialReward *json.Uint64 `json:"potentialReward,omitempty"`
}

Delegator is the representation of a delegator sent via RPC.

type Height

type Height json.Uint64

func (Height) IsProposed

func (h Height) IsProposed() bool

func (Height) MarshalJSON

func (h Height) MarshalJSON() ([]byte, error)

func (*Height) UnmarshalJSON

func (h *Height) UnmarshalJSON(b []byte) error

type Owner

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

Owner is the representation of an owner sent via RPC.

type PermissionlessValidator

type PermissionlessValidator struct {
	Staker
	// L1 Validator fields
	ValidationID          *ids.ID      `json:"validationID,omitempty"`
	RemainingBalanceOwner *Owner       `json:"remainingBalanceOwner,omitempty"`
	DeactivationOwner     *Owner       `json:"deactivationOwner,omitempty"`
	MinNonce              *json.Uint64 `json:"minNonce,omitempty"`
	Balance               *json.Uint64 `json:"balance,omitempty"`

	// Standard validator fields
	ValidationRewardOwner  *Owner                    `json:"validationRewardOwner,omitempty"`
	DelegationRewardOwner  *Owner                    `json:"delegationRewardOwner,omitempty"`
	PotentialReward        *json.Uint64              `json:"potentialReward,omitempty"`
	AccruedDelegateeReward *json.Uint64              `json:"accruedDelegateeReward,omitempty"`
	DelegationFee          json.Float32              `json:"delegationFee"`
	Uptime                 *json.Float32             `json:"uptime,omitempty"`
	Connected              *bool                     `json:"connected,omitempty"`
	Signer                 *signer.ProofOfPossession `json:"signer,omitempty"`
	DelegatorCount         *json.Uint64              `json:"delegatorCount,omitempty"`
	DelegatorWeight        *json.Uint64              `json:"delegatorWeight,omitempty"`
	Delegators             *[]PrimaryDelegator       `json:"delegators,omitempty"`
}

PermissionlessValidator is the representation of a permissionless validator sent via RPC.

type PrimaryDelegator

type PrimaryDelegator struct {
	Staker
	RewardOwner     *Owner       `json:"rewardOwner,omitempty"`
	PotentialReward *json.Uint64 `json:"potentialReward,omitempty"`
}

PrimaryDelegator is the representation of a primary delegator sent via RPC.

type Staker

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

Staker is the representation of a staker sent via RPC.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL