mirror of
https://github.com/luxfi/node.git
synced 2026-10-30 15:24:05 +00:00
zeekay
7cf87b230b
The module already called itself github.com/luxfi/node while containing no node in Go: cmd/luxd was twenty-one lines that printed the size of a few types, and the Go column of the matrix measured a VM plugin. A repo that fetches the thing it claims to be has not replaced it, so the Go sources move in — 1515 files, the daemon and everything under it — and the build reaches outside this module for nothing. Rust and C++ sit beside it unchanged and are still measured against it by the differential. That is the point of one repo: the reference implementation and the two ports are the same checkout, so parity is a thing you can run rather than a thing you assert. Verified: builds, and the closure carries no lux-private — checked at build time rather than believed. The daemon starts twelve chains on a local network (P X C Q Z A B G K M F, plus D through its plugin) and reports healthy.
208 lines
14 KiB
Go
208 lines
14 KiB
Go
// Code generated by zipdoc; DO NOT EDIT.
|
|
|
|
package platformvm
|
|
|
|
import (
|
|
"github.com/zap-proto/zip"
|
|
)
|
|
|
|
func init() {
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /balance", zip.Doc{
|
|
Description: "Returns what a set of addresses holds, per asset and in total.\n\nDeprecated: read the UTXOs with getUTXOs and add them up. The totals here are\na walk of every UTXO an address owns, which is unbounded work for a caller\nthat usually wants one asset.",
|
|
Fields: map[string]string{
|
|
"GetBalanceResponse.balance": "Balance, in µLUX, of the address",
|
|
"UTXOID.txID": "Serialized:",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /block", zip.Doc{
|
|
Description: "Returns a block by its id.\n\nThe encoding chooses the shape of the answer: hex returns the block's bytes as\none string, and json returns the block as an object.",
|
|
Fields: map[string]string{
|
|
"GetBlockResponse.encoding": "If GetBlockResponse.Encoding is formatting.Hex, GetBlockResponse.Block is\nthe string representation of the block under hex encoding.\nIf GetBlockResponse.Encoding is formatting.JSON, GetBlockResponse.Block\nis the actual block returned as a JSON.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /block/:height", zip.Doc{
|
|
Description: "Returns the accepted block at a height.\n\nThe encoding chooses the shape of the answer: hex returns the block's bytes as\none string, and json returns the block as an object.",
|
|
Fields: map[string]string{
|
|
"GetBlockResponse.encoding": "If GetBlockResponse.Encoding is formatting.Hex, GetBlockResponse.Block is\nthe string representation of the block under hex encoding.\nIf GetBlockResponse.Encoding is formatting.JSON, GetBlockResponse.Block\nis the actual block returned as a JSON.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /blockchain/net", zip.Doc{
|
|
Description: "Returns the net that validates a blockchain.",
|
|
Fields: map[string]string{
|
|
"ValidatedByArgs.blockchainID": "ValidatedBy returns the ID of the Net validating the blockchain with this ID",
|
|
"ValidatedByResponse.netID": "ID of the Net validating the specified blockchain",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /blockchain/status", zip.Doc{
|
|
Description: "Returns how far along a blockchain is: whether this node\nvalidates it, whether it has been created, and whether it is preferred.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /blockchains", zip.Doc{
|
|
Description: "Returns every blockchain that exists, with the net that\nvalidates it and the VM it runs.",
|
|
Fields: map[string]string{
|
|
"APIBlockchain.id": "Blockchain's ID",
|
|
"APIBlockchain.name": "Blockchain's (non-unique) human-readable name",
|
|
"APIBlockchain.netID": "Net that validates the blockchain",
|
|
"APIBlockchain.vmID": "Virtual Machine the blockchain runs",
|
|
"GetBlockchainsResponse.blockchains": "blockchains that exist",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /chains", zip.Doc{
|
|
Description: "Returns the chains named, or every chain when none is named. The\nprimary network is always among them.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /fee", zip.Doc{
|
|
Description: "Returns the chain's current fee state: the gas consumed, the\nexcess it is priced off, the price that excess implies, and the time it was\nread at.",
|
|
Fields: map[string]string{
|
|
"Time.nanos": "Nanos is the nanosecond within that second.",
|
|
"Time.offset": "Offset is seconds east of UTC.",
|
|
"Time.seconds": "Seconds is seconds since the epoch.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /fee/config", zip.Doc{
|
|
Description: "Returns the chain's dynamic-fee configuration: what gas each\ndimension of a transaction costs, the capacity and target per second, and the\nconstants the price curve is drawn from.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /fee/validator", zip.Doc{
|
|
Description: "Returns what an L1 validator is currently charged per\nsecond to keep validating, and the time it was read at.",
|
|
Fields: map[string]string{
|
|
"Time.nanos": "Nanos is the nanosecond within that second.",
|
|
"Time.offset": "Offset is seconds east of UTC.",
|
|
"Time.seconds": "Seconds is seconds since the epoch.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /fee/validator/config", zip.Doc{
|
|
Description: "Returns the configuration the L1 validator fee is\ncalculated from.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /height", zip.Doc{
|
|
Description: "Returns the height of the last accepted block.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /height/proposed", zip.Doc{
|
|
Description: "Returns the height the next proposal will be built at.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /net", zip.Doc{
|
|
Description: "Returns a net's ownership and, if it has been converted to an L1, the\nchain and address that manage its validators.",
|
|
Fields: map[string]string{
|
|
"GetNetArgs.netID": "ID of the net to retrieve information about",
|
|
"GetNetResponse.controlKeys": "net auth information for a permissioned net",
|
|
"GetNetResponse.conversionID": "net conversion information for an L1",
|
|
"GetNetResponse.isPermissioned": "whether it is permissioned or not",
|
|
"GetNetResponse.netTransformationTxID": "net transformation tx ID for an elastic net",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /net/blockchains", zip.Doc{
|
|
Description: "Returns the blockchains a net validates.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /nets", zip.Doc{
|
|
Description: "Returns the nets named, or every net when none is named. The primary\nnetwork is always among them.\n\nDeprecated: use getChains, which answers the same thing under the name the\nconcept now has.",
|
|
Fields: map[string]string{
|
|
"APINet.controlKeys": "Each element of [ControlKeys] the address of a public key.\nA transaction to add a validator to this net requires\nsignatures from [Threshold] of these keys to be valid.",
|
|
"APINet.id": "ID of the net",
|
|
"GetNetsArgs.ids": "IDs of the nets to retrieve information about\nIf omitted, gets all nets",
|
|
"GetNetsResponse.nets": "Each element is a net that exists\nNull if there are no nets other than the primary network",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /stake", zip.Doc{
|
|
Description: "Returns what a set of addresses has staked on the primary network,\nand the outputs that stake is locked in.\n\nDeprecated: read the stake off the validators with getCurrentValidators, or\noff the staking transaction with getTx. This walks every current and pending\nstaker on every call.",
|
|
Fields: map[string]string{
|
|
"GetStakeReply.encoding": "Encoding of [Outputs]",
|
|
"GetStakeReply.stakedOutputs": "String representation of staked outputs\nEach is of type lux.TransferableOutput",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /stake/asset", zip.Doc{
|
|
Description: "Returns the asset a net is staked in.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /stake/min", zip.Doc{
|
|
Description: "Returns the least that can be staked on a net, as a validator\nand as a delegator.",
|
|
Fields: map[string]string{
|
|
"GetMinStakeReply.minDelegatorStake": "Minimum stake, in µLUX, that can be delegated on the primary network",
|
|
"GetMinStakeReply.minValidatorStake": "The minimum amount of tokens one must bond to be a validator",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /stake/total", zip.Doc{
|
|
Description: "Returns the total weight of a net's validator set.",
|
|
Fields: map[string]string{
|
|
"GetTotalStakeArgs.netID": "Net we're getting the total stake\nIf omitted returns Primary network weight",
|
|
"GetTotalStakeReply.stake": "Deprecated: Use Weight instead.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /supply", zip.Doc{
|
|
Description: "Returns an upper bound on the supply of LUX on a net, and\nthe height it was read at.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /timestamp", zip.Doc{
|
|
Description: "Returns the chain's current time.",
|
|
Fields: map[string]string{
|
|
"GetTimestampReply.timestamp": "Current timestamp",
|
|
"Time.nanos": "Nanos is the nanosecond within that second.",
|
|
"Time.offset": "Offset is seconds east of UTC.",
|
|
"Time.seconds": "Seconds is seconds since the epoch.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /tx", zip.Doc{
|
|
Description: "Returns a transaction by its id.\n\nThe encoding chooses the shape of the answer: hex returns the signed bytes as\none string, and json returns the transaction as an object.",
|
|
Fields: map[string]string{
|
|
"GetTxReply.tx": "If [GetTxArgs.Encoding] is [Hex], [Tx] is the string representation of\nthe tx under hex encoding.\nIf [GetTxArgs.Encoding] is [JSON], [Tx] is the actual tx, which will be\nreturned as JSON to the caller.",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /tx/rewards", zip.Doc{
|
|
Description: "Returns the UTXOs paid out when a staking transaction's period\nended.",
|
|
Fields: map[string]string{
|
|
"GetRewardUTXOsReply.encoding": "Encoding specifies the encoding format the UTXOs are returned in",
|
|
"GetRewardUTXOsReply.numFetched": "Number of UTXOs returned",
|
|
"GetRewardUTXOsReply.utxos": "The UTXOs",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /tx/status", zip.Doc{
|
|
Description: "Returns where a transaction stands: accepted, still processing,\ndropped with a reason, or unknown to this node.",
|
|
Fields: map[string]string{
|
|
"GetTxStatusResponse.reason": "Reason this tx was dropped.\nOnly non-empty if Status is dropped",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /utxos", zip.Doc{
|
|
Description: "Returns one page of the UTXOs a set of addresses owns.\n\nA page ends at a cursor, and the next page starts from it: pass the endIndex\nof one answer as the startIndex of the next. The same UTXO may appear in two\npages if the set changes underneath the walk.",
|
|
Fields: map[string]string{
|
|
"GetUTXOsReply.encoding": "Encoding specifies the encoding format the UTXOs are returned in.",
|
|
"GetUTXOsReply.endIndex": "The last UTXO that was returned, and the address it corresponds to.\nUsed for pagination. To get the rest of the UTXOs, call GetUTXOs\nagain and set [StartIndex] to this value.",
|
|
"GetUTXOsReply.numFetched": "Number of UTXOs returned.",
|
|
"GetUTXOsReply.utxos": "The UTXOs.",
|
|
"Index.address": "The address as a string",
|
|
"Index.utxo": "The UTXO ID as a string",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /validator", zip.Doc{
|
|
Description: "Returns one L1 validator by its validation id, with the\nbalance left to pay for its continued validation.",
|
|
Fields: map[string]string{
|
|
"BaseL1Validator.balance": "Balance is the remaining amount of LUX this L1 validator has for paying\nthe continuous fee, according to the last accepted state. If the\nvalidator is inactive, the balance will be 0.",
|
|
"BaseL1Validator.publicKey": "PublicKey is the compressed BLS public key of the validator",
|
|
"GetL1ValidatorReply.height": "Height is the height of the last accepted block",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /validators", zip.Doc{
|
|
Description: "Returns a net's current validators.\n\nNaming nodes narrows the answer to those nodes and adds each one's delegators\nin full; naming one node is how a caller reads a single validator's\ndelegation. Naming none returns every validator with its delegators counted\nand weighed but not listed.",
|
|
Fields: map[string]string{
|
|
"BaseL1Validator.balance": "Balance is the remaining amount of LUX this L1 validator has for paying\nthe continuous fee, according to the last accepted state. If the\nvalidator is inactive, the balance will be 0.",
|
|
"BaseL1Validator.publicKey": "PublicKey is the compressed BLS public key of the validator",
|
|
"GetCurrentValidatorsArgs.netID": "Net we're listing the validators of\nIf omitted, defaults to primary network",
|
|
"GetCurrentValidatorsArgs.nodeIDs": "NodeIDs of validators to request. If [NodeIDs]\nis empty, it fetches all current validators. If\nsome nodeIDs are not currently validators, they\nwill be omitted from the response.",
|
|
"PermissionlessValidator.delegationRewardOwner": "The owner of the rewards from delegations during the validation period,\nif applicable.",
|
|
"PermissionlessValidator.delegatorCount": "The delegators delegating to this validator",
|
|
"PermissionlessValidator.rewardOwner": "Deprecated: RewardOwner has been replaced by ValidationRewardOwner and\n DelegationRewardOwner.",
|
|
"PermissionlessValidator.validationRewardOwner": "The owner of the rewards from the validation period, if applicable.",
|
|
"ProofOfPossession.proofOfPossession": "BLS signature proving ownership of [PublicKey]. The signed message is the\n[PublicKey].",
|
|
"Staker.stakeAmount": "Deprecated: Use Weight instead",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /validators/all", zip.Doc{
|
|
Description: "Returns every net's validator set as it stood at a height,\nthe primary network included.\n\nThe height \"proposed\" asks for the height the next proposal will be built at.",
|
|
Fields: map[string]string{
|
|
"GetValidatorOutput.CoronaPubKey": "Corona public key (post-quantum)",
|
|
"GetValidatorOutput.PublicKey": "BLS public key (classical)",
|
|
"GetValidatorOutput.TxID": "Transaction ID that added this validator",
|
|
"GetValidatorOutput.Weight": "Alias for Light for backward compatibility",
|
|
},
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm GET /validators/at", zip.Doc{
|
|
Description: "Returns a net's validator set as it stood at a height: each\nnode, its BLS key where it has one, and its weight.\n\nThe height \"proposed\" asks for the height the next proposal will be built at.",
|
|
})
|
|
zip.Describe("github.com/luxfi/node/vms/platformvm POST /tx", zip.Doc{
|
|
Description: "Hands already-signed transaction bytes to consensus and returns the\ntransaction's id.\n\nThe node checks no signature here and holds no key that could have made one:\nthe bytes carry their own authority, which is why this address answers anyone\n(see [server.Relay]).",
|
|
})
|
|
}
|