package iotextypes

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ActionCore, Execution

• string address = 1

• repeated string storageKeys = 2

Account Metadata

Used in: iotexapi.GetAccountResponse

• string address = 1

• string balance = 2

• uint64 nonce = 3

• uint64 pendingNonce = 4

• uint64 numActions = 5

• bool isContract = 6

• bytes contractByteCode = 7

Used in: iotexapi.ActionInfo, iotexapi.EstimateGasForActionRequest, iotexapi.GetActPoolActionsResponse, iotexapi.SendActionRequest, Actions, BlockBody

• optional ActionCore core = 1

• bytes senderPubKey = 2

• bytes signature = 3

• Encoding encoding = 4

Used in: Action

• uint32 version = 1

• uint64 nonce = 2

• uint64 gasLimit = 3

• string gasPrice = 4

• uint32 chainID = 5

• string gasTipCap = 6

• string gasFeeCap = 7

• optional BlobTxData blobTxData = 8

• repeated AccessTuple accessList = 9

• uint32 txType = 28

• repeated SetCodeAuthorization setCodeAuthList = 29

• oneof action

  • Transfer transfer = 10

  • TxContainer txContainer = 11

  • Execution execution = 12

  • StartSubChain startSubChain = 13

    FedChain

  • StopSubChain stopSubChain = 14

  • PutBlock putBlock = 15

  • CreateDeposit createDeposit = 16

  • SettleDeposit settleDeposit = 17

  • CreatePlumChain createPlumChain = 18

    PlumChain

  • TerminatePlumChain terminatePlumChain = 19

  • PlumPutBlock plumPutBlock = 20

  • PlumCreateDeposit plumCreateDeposit = 21

  • PlumStartExit plumStartExit = 22

  • PlumChallengeExit plumChallengeExit = 23

  • PlumResponseChallengeExit plumResponseChallengeExit = 24

  • PlumFinalizeExit plumFinalizeExit = 25

  • PlumSettleDeposit plumSettleDeposit = 26

  • PlumTransfer plumTransfer = 27

  • DepositToRewardingFund depositToRewardingFund = 30

    Rewarding protocol actions

  • ClaimFromRewardingFund claimFromRewardingFund = 31

  • GrantReward grantReward = 32

  • StakeCreate stakeCreate = 40

    Native staking

  • StakeReclaim stakeUnstake = 41

  • StakeReclaim stakeWithdraw = 42

  • StakeAddDeposit stakeAddDeposit = 43

  • StakeRestake stakeRestake = 44

  • StakeChangeCandidate stakeChangeCandidate = 45

  • StakeTransferOwnership stakeTransferOwnership = 46

  • CandidateRegister candidateRegister = 47

  • CandidateBasicInfo candidateUpdate = 48

  • PutPollResult putPollResult = 50

Deprecated

Used in: iotexapi.GetEvmTransfersByActionHashResponse, BlockEvmTransfer

• bytes actionHash = 1

• uint64 numEvmTransfers = 2

• repeated EvmTransfer evmTransfers = 3

a pack of actions

• repeated Action actions = 1

Used in: ActionCore

• string blobFeeCap = 1

• repeated bytes blobHashes = 2

• optional BlobTxSidecar blobTxSidecar = 3

Used in: BlobTxData

• repeated bytes blobs = 1

  Blobs needed by the blob pool

• repeated bytes commitments = 2

  Commitments needed by the blob pool

• repeated bytes proofs = 3

  Proofs needed by the blob pool

block consists of header followed by transactions hash of current block can be computed from header hence not stored

Used in: iotexapi.BlockInfo, BlockProposal, BlockStore

• optional BlockHeader header = 1

• optional BlockBody body = 2

• optional BlockFooter footer = 3

body of a block

Used in: Block

• repeated Action actions = 1

Deprecated

Used in: iotexapi.GetEvmTransfersByBlockHeightResponse

• uint64 blockHeight = 1

• uint64 numEvmTransfers = 2

• repeated ActionEvmTransfer actionEvmTransfers = 3

footer of a block

Used in: Block

• repeated Endorsement endorsements = 1

• optional google.protobuf.Timestamp timestamp = 2

header of a block

Used in: Block

• optional BlockHeaderCore core = 1

• bytes producerPubkey = 2

• bytes signature = 3

Used in: BlockHeader

• uint32 version = 1

• uint64 height = 2

• optional google.protobuf.Timestamp timestamp = 3

• bytes prevBlockHash = 4

• bytes txRoot = 5

• bytes deltaStateDigest = 6

• bytes receiptRoot = 7

• bytes logsBloom = 8

BlockIdentifier Metadata

Used in: iotexapi.GetAccountResponse, iotexapi.GetTransactionLogByBlockHeightResponse, iotexapi.ReadStateResponse, iotexapi.StreamBlocksResponse

• string hash = 1

• uint64 height = 2

Block Metadata

Used in: iotexapi.GetBlockMetasResponse

• string hash = 1

• uint64 height = 2

• optional google.protobuf.Timestamp timestamp = 3

• int64 numActions = 4

• string producerAddress = 5

• string transferAmount = 6

• string txRoot = 7

• string receiptRoot = 8

• string deltaStateDigest = 9

• string logsBloom = 10

• string previousBlockHash = 11

• uint64 gasLimit = 12

• uint64 gasUsed = 13

Used in: ConsensusMessage

• optional Block block = 1

• repeated Endorsement endorsements = 2

Used in: BlockStores

• optional Block block = 1

• repeated Receipt receipts = 2

• repeated BlockStore blockStores = 1

• uint64 total = 1

• uint64 active = 2

Candidates and list of candidates

Used in: CandidateList

• string address = 1

• bytes votes = 2

• bytes pubKey = 3

• string rewardAddress = 4

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore, CandidateRegister

• string name = 1

• string operatorAddress = 2

• string rewardAddress = 3

Used in: PutPollResult

• repeated Candidate candidates = 1

• repeated CandidateV2 candidates = 1

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• optional CandidateBasicInfo candidate = 1

• string stakedAmount = 2

• uint32 stakedDuration = 3

• bool autoStake = 4

• string ownerAddress = 5

  if ownerAddress is absent, owner of candidate is the sender

• bytes payload = 6

Used in: CandidateListV2

• string ownerAddress = 1

• string operatorAddress = 2

• string rewardAddress = 3

• string name = 4

• string totalWeightedVotes = 5

• uint64 selfStakeBucketIdx = 6

• string selfStakingTokens = 7

Blockchain Metadata

Used in: iotexapi.GetChainMetaResponse

• uint64 height = 1

• int64 numActions = 2

• int64 tps = 3

• optional EpochData epoch = 4

• float tpsFloat = 5

• uint32 chainID = 6

Used in: ActionCore

• string amount = 1

• bytes data = 2

• uint64 height = 1

• optional Endorsement endorsement = 2

• oneof msg

  • BlockProposal blockProposal = 100

  • ConsensusVote vote = 101

Used in: ConsensusMessage

• bytes blockHash = 1

• ConsensusVote.Topic topic = 2

Used in: ConsensusVote

• PROPOSAL = 0

• LOCK = 1

• COMMIT = 2

Used in: ContractStakingBucketTypeList

• string stakedAmount = 1

• uint32 stakedDuration = 2

• repeated ContractStakingBucketType bucketTypes = 1

Used in: ActionCore

• uint32 chainID = 1

• string amount = 2

• string recipient = 3

plum main chain APIs

Used in: ActionCore

(message has no fields)

Used in: ActionCore

• string amount = 1

• bytes data = 2

Used in: iotexapi.GetElectionBucketsResponse

• bytes voter = 1

• bytes candidate = 2

• bytes amount = 3

• optional google.protobuf.Timestamp startTime = 4

• optional google.protobuf.Duration duration = 5

• bool decay = 6

Used in: Action

• IOTEX_PROTOBUF = 0

• ETHEREUM_EIP155 = 1

• ETHEREUM_RLP = 1

• ETHEREUM_UNPROTECTED = 2

• TX_CONTAINER = 128

Used in: BlockFooter, BlockProposal, ConsensusMessage

• optional google.protobuf.Timestamp timestamp = 1

• bytes endorser = 2

• bytes signature = 3

Used in: iotexapi.GetEpochMetaResponse, ChainMeta

• uint64 num = 1

• uint64 height = 2

• uint64 gravityChainStartHeight = 3

Deprecated

Used in: ActionEvmTransfer, EvmTransferList

• bytes amount = 1

• string from = 2

• string to = 3

Deprecated

• repeated EvmTransfer evmTransfers = 1

Used in: iotexapi.EstimateActionGasConsumptionRequest, iotexapi.ReadContractRequest, ActionCore

• string amount = 1

• string contract = 2

• bytes data = 3

• repeated AccessTuple accessList = 4

• optional GenesisBlockchain blockchain = 1

• optional GenesisAccount account = 2

• optional GenesisPoll poll = 3

• optional GenesisRewarding rewarding = 4

Used in: Genesis

• repeated string initBalanceAddrs = 1

• repeated string initBalances = 2

Used in: Genesis

• int64 timestamp = 1

• uint64 blockGasLimit = 2

• uint64 actionGasLimit = 3

• int64 blockInterval = 4

• uint64 numSubEpochs = 5

• uint64 numDelegates = 6

• uint64 numCandidateDelegates = 7

• bool timeBasedRotation = 8

Used in: GenesisPoll

• string operatorAddr = 1

• string rewardAddr = 2

• string votes = 3

Used in: Genesis

• bool enableGravityChainVoting = 1

• uint64 gravityChainStartHeight = 2

• string registerContractAddress = 3

• string stakingContractAddress = 4

• string voteThreshold = 5

• string scoreThreshold = 6

• string selfStakingThreshold = 7

• repeated GenesisDelegate delegates = 8

Used in: Genesis

• string initAdminAddr = 1

• string initBalance = 2

• string blockReward = 3

• string epochReward = 4

• uint64 numDelegatesForEpochReward = 5

• string foundationBonus = 6

• uint64 numDelegatesForFoundationBonus = 7

• uint64 foundationBonusLastEpoch = 8

• uint64 productivityThreshold = 9

Used in: ActionCore

• RewardType type = 1

• uint64 height = 2

Used in: iotexapi.GetLogsResponse, iotexapi.StreamLogsResponse, Logs, Receipt

• string contractAddress = 1

• repeated bytes topics = 2

• bytes data = 3

• uint64 blkHeight = 4

• bytes actHash = 5

• uint32 index = 6

• bytes blkHash = 7

• uint32 txIndex = 8

• repeated Log logs = 1

Used in: PutBlock

• string name = 1

• bytes value = 2

• optional NodeInfoCore info = 1

• bytes signature = 2

Used in: NodeInfo

• string version = 1

• uint64 height = 2

• optional google.protobuf.Timestamp timestamp = 3

• string address = 4

(message has no fields)

Used in: ActionCore

• string subChainAddress = 1

• uint64 coinID = 2

• bytes challengeTransfer = 3

• bytes challengeTransferBlockProof = 4

• uint64 challengeTransferBlockHeight = 5

Used in: ActionCore

• string subChainAddress = 1

• string amount = 2

• string recipient = 3

Used in: ActionCore

• string subChainAddress = 1

• uint64 coinID = 2

Used in: ActionCore

• string subChainAddress = 1

• uint64 height = 2

• map<string, bytes> roots = 3

Used in: ActionCore

• string subChainAddress = 1

• uint64 coinID = 2

• bytes challengeTransfer = 3

• bytes responseTransfer = 4

• bytes responseTransferBlockProof = 5

• uint64 previousTransferBlockHeight = 6

plum sub chain APIs

Used in: ActionCore

• uint64 coinID = 1

Used in: ActionCore

• string subChainAddress = 1

• bytes previousTransfer = 2

• bytes previousTransferBlockProof = 3

• uint64 previousTransferBlockHeight = 4

• bytes exitTransfer = 5

• bytes exitTransferBlockProof = 6

• uint64 exitTransferBlockHeight = 7

Used in: ActionCore

• uint64 coinID = 1

• bytes denomination = 2

• string owner = 3

• string recipient = 4

ProbationCandidateList (slashing #1)

• repeated ProbationCandidateList.Info probationList = 1

• uint32 intensityRate = 2

Used in: ProbationCandidateList

• string address = 1

• uint32 count = 2

Used in: ActionCore

• string subChainAddress = 1

• uint64 height = 2

• repeated MerkleRoot roots = 3

Used in: ActionCore

• uint64 height = 1

• optional CandidateList candidates = 2

Used in: iotexapi.BlockInfo, iotexapi.ReadContractResponse, iotexapi.ReceiptInfo, BlockStore, Receipts

• uint64 status = 1

• uint64 blkHeight = 2

• bytes actHash = 3

• uint64 gasConsumed = 4

• string contractAddress = 5

• repeated Log logs = 6

• string executionRevertMsg = 7

• uint32 txIndex = 8

BELOW ARE DEFINITIONS FOR EVM ERROR CLASSIFICATION IN RECEIPT STATUS

• Failure = 0

• Success = 1

• ErrUnknown = 100

  1xx for EVM ErrorCode

• ErrOutOfGas = 101

• ErrCodeStoreOutOfGas = 102

• ErrDepth = 103

• ErrContractAddressCollision = 104

• ErrNoCompatibleInterpreter = 105

• ErrExecutionReverted = 106

• ErrMaxCodeSizeExceeded = 107

• ErrWriteProtection = 108

• ErrInvalidSubroutineEntry = 109

• ErrInsufficientBalance = 110

• ErrInvalidJump = 111

• ErrReturnDataOutOfBounds = 112

• ErrGasUintOverflow = 113

• ErrInvalidRetsub = 114

• ErrReturnStackExceeded = 115

• ErrInvalidCode = 116

• ErrLoadAccount = 200

  2xx for Staking ErrorCode

• ErrNotEnoughBalance = 201

• ErrInvalidBucketIndex = 202

• ErrUnauthorizedOperator = 203

• ErrInvalidBucketType = 204

• ErrCandidateNotExist = 205

• ErrReduceDurationBeforeMaturity = 206

• ErrUnstakeBeforeMaturity = 207

• ErrWithdrawBeforeUnstake = 208

• ErrWithdrawBeforeMaturity = 209

• ErrCandidateAlreadyExist = 210

• ErrCandidateConflict = 211

• ErrInvalidBucketAmount = 212

• ErrWriteAccount = 213

• ErrWriteBucket = 214

• ErrWriteCandidate = 215

Receipts consists of a collection of recepit

• repeated Receipt receipts = 1

Used in: GrantReward

• BlockReward = 0

• EpochReward = 1

Server Metadata

Used in: iotexapi.GetServerMetaResponse

• string packageVersion = 1

• string packageCommitID = 2

• string gitStatus = 3

• string goVersion = 4

• string buildTime = 5

Used in: ActionCore

• uint32 chainID = 1

• bytes address = 2

• uint64 nonce = 3

• uint64 v = 4

• bytes r = 5

• bytes s = 6

Used in: ActionCore

• string amount = 1

• string recipient = 2

• uint64 index = 3

add the amount of bucket

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• uint64 bucketIndex = 1

• string amount = 2

• bytes payload = 3

move the bucket to vote for another candidate or transfer the ownership of bucket to another voters

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• uint64 bucketIndex = 1

• string candidateName = 2

• bytes payload = 3

create stake

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• string candidateName = 1

• string stakedAmount = 2

• uint32 stakedDuration = 3

• bool autoStake = 4

• bytes payload = 5

unstake or withdraw

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• uint64 bucketIndex = 1

• bytes payload = 2

restake the duration and autoStake flag of bucket

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• uint64 bucketIndex = 1

• uint32 stakedDuration = 2

• bool autoStake = 3

• bytes payload = 4

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• uint64 bucketIndex = 1

• string voterAddress = 2

• bytes payload = 3

Used in: ActionCore

• uint32 chainID = 1

  TODO: chainID chould be assigned by system and returned via a receipt

• string securityDeposit = 2

• string operationDeposit = 3

• uint64 startHeight = 4

• uint64 parentHeightOffset = 5

Used in: ActionCore

• uint32 chainID = 1

• uint64 stopHeight = 2

• string subChainAddress = 3

Used in: ActionCore

• string subChainAddress = 1

Used in: iotexapi.GetTransactionLogByActionHashResponse, TransactionLogs

• bytes actionHash = 1

• uint64 numTransactions = 2

• repeated TransactionLog.Transaction transactions = 3

Used in: TransactionLog

• bytes topic = 1

• string amount = 2

• string sender = 3

• string recipient = 4

• TransactionLogType type = 5

Used in: TransactionLog.Transaction

• IN_CONTRACT_TRANSFER = 0

• WITHDRAW_BUCKET = 1

• CREATE_BUCKET = 2

• DEPOSIT_TO_BUCKET = 3

• CANDIDATE_SELF_STAKE = 4

• CANDIDATE_REGISTRATION_FEE = 5

• GAS_FEE = 6

• NATIVE_TRANSFER = 7

• DEPOSIT_TO_REWARDING_FUND = 8

• CLAIM_FROM_REWARDING_FUND = 9

Used in: iotexapi.BlockInfo, iotexapi.GetTransactionLogByBlockHeightResponse

• repeated TransactionLog logs = 1

Used in: iotexapi.TraceTransactionStructLogsResponse

• uint64 pc = 1

• uint64 op = 2

• uint64 gas = 3

• uint64 gasCost = 4

• string memory = 5

• int32 memSize = 6

• repeated string stack = 7

• string returnData = 8

• int32 depth = 9

• uint64 refund = 10

• string opName = 11

• string error = 12

Used in: iotexapi.EstimateActionGasConsumptionRequest, ActionCore

• string amount = 1

  used by state-based model

• string recipient = 2

• bytes payload = 3

Used in: ActionCore

• bytes raw = 1

Used in: VoteBucketList

• uint64 index = 1

• string candidateAddress = 2

• string stakedAmount = 3

• uint32 stakedDuration = 4

• optional google.protobuf.Timestamp createTime = 5

• optional google.protobuf.Timestamp stakeStartTime = 6

• optional google.protobuf.Timestamp unstakeStartTime = 7

• bool autoStake = 8

• string owner = 9

• string contractAddress = 10

• uint64 stakedDurationBlockNumber = 11

• uint64 createBlockHeight = 12

• uint64 stakeStartBlockHeight = 13

• uint64 unstakeStartBlockHeight = 14

• repeated VoteBucket buckets = 1