Documentation
¶
Index ¶
Constants ¶
View Source
const MaxPageSize = 1024
Max number of items allowed in a page
Variables ¶
View Source
var (
ErrNoFunds = errors.New("no spendable funds were found")
)
Functions ¶
This section is empty.
Types ¶
type AtomicTxBuilder ¶
type AtomicTxBuilder interface { // chainID: chain to import UTXOs from // to: address of recipient // keys: keys to import the funds // changeAddr: address to send change to, if there is any NewImportTx( chainID ids.ID, to ids.ShortID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // amount: amount of tokens to export // chainID: chain to send the UTXOs to // to: address of recipient // keys: keys to pay the fee and provide the tokens // changeAddr: address to send change to, if there is any NewExportTx( amount uint64, chainID ids.ID, to ids.ShortID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) }
type Builder ¶ added in v1.7.18
type Builder interface { AtomicTxBuilder DecisionTxBuilder ProposalTxBuilder }
type DecisionTxBuilder ¶
type DecisionTxBuilder interface { // subnetID: ID of the subnet that validates the new chain // genesisData: byte repr. of genesis state of the new chain // vmID: ID of VM this chain runs // fxIDs: ids of features extensions this chain supports // chainName: name of the chain // keys: keys to sign the tx // changeAddr: address to send change to, if there is any NewCreateChainTx( subnetID ids.ID, genesisData []byte, vmID ids.ID, fxIDs []ids.ID, chainName string, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // threshold: [threshold] of [ownerAddrs] needed to manage this subnet // ownerAddrs: control addresses for the new subnet // keys: keys to pay the fee // changeAddr: address to send change to, if there is any NewCreateSubnetTx( threshold uint32, ownerAddrs []ids.ShortID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // amount: amount the sender is sending // owner: recipient of the funds // keys: keys to sign the tx and pay the amount // changeAddr: address to send change to, if there is any NewBaseTx( amount uint64, owner secp256k1fx.OutputOwners, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) }
type ProposalTxBuilder ¶
type ProposalTxBuilder interface { // stakeAmount: amount the validator stakes // startTime: unix time they start validating // endTime: unix time they stop validating // nodeID: ID of the node we want to validate with // rewardAddress: address to send reward to, if applicable // shares: 10,000 times percentage of reward taken from delegators // keys: Keys providing the staked tokens // changeAddr: Address to send change to, if there is any NewAddValidatorTx( stakeAmount, startTime, endTime uint64, nodeID ids.NodeID, rewardAddress ids.ShortID, shares uint32, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // stakeAmount: amount the delegator stakes // startTime: unix time they start delegating // endTime: unix time they stop delegating // nodeID: ID of the node we are delegating to // rewardAddress: address to send reward to, if applicable // keys: keys providing the staked tokens // changeAddr: address to send change to, if there is any NewAddDelegatorTx( stakeAmount, startTime, endTime uint64, nodeID ids.NodeID, rewardAddress ids.ShortID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // weight: sampling weight of the new validator // startTime: unix time they start delegating // endTime: unix time they top delegating // nodeID: ID of the node validating // subnetID: ID of the subnet the validator will validate // keys: keys to use for adding the validator // changeAddr: address to send change to, if there is any NewAddSubnetValidatorTx( weight, startTime, endTime uint64, nodeID ids.NodeID, subnetID ids.ID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // Creates a transaction that removes [nodeID] // as a validator from [subnetID] // keys: keys to use for removing the validator // changeAddr: address to send change to, if there is any NewRemoveSubnetValidatorTx( nodeID ids.NodeID, subnetID ids.ID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // Creates a transaction that transfers ownership of [subnetID] // threshold: [threshold] of [ownerAddrs] needed to manage this subnet // ownerAddrs: control addresses for the new subnet // keys: keys to use for modifying the subnet // changeAddr: address to send change to, if there is any NewTransferSubnetOwnershipTx( subnetID ids.ID, threshold uint32, ownerAddrs []ids.ShortID, keys []*secp256k1.PrivateKey, changeAddr ids.ShortID, ) (*txs.Tx, error) // RewardStakerTx creates a new transaction that proposes to remove the staker // [validatorID] from the default validator set. NewRewardValidatorTx(txID ids.ID) (*txs.Tx, error) }
Click to show internal directories.
Click to hide internal directories.