A collection of add-to-credits operations, each tagged with block height
This allows clients to determine which adds to apply based on their sync height
| Field | Type | Label | Description |
| entries | BlockHeightCreditEntry | repeated |
|
| Field | Type | Label | Description |
| address | bytes |
|
|
| set_balance | uint64 |
|
|
| add_to_balance | uint64 |
|
| Field | Type | Label | Description |
| block_changes | BlockAddressBalanceChanges | repeated |
|
| Field | Type | Label | Description |
| address_info_entries | AddressInfoEntry | repeated |
|
| Field | Type | Label | Description |
| address | bytes |
|
|
| balance_and_nonce | BalanceAndNonce | optional |
|
AllKeys is an empty message used to signify a request for all keys
| Field | Type | Label | Description |
| balance | uint64 |
|
|
| nonce | uint32 |
|
| Field | Type | Label | Description |
| block_height | uint64 |
|
|
| changes | AddressBalanceChange | repeated |
|
Entry for block height to credits mapping in AddToCreditsOperations
| Field | Type | Label | Description |
| block_height | uint64 |
|
|
| credits | uint64 |
|
| Field | Type | Label | Description |
| block_height | uint64 |
|
|
| nullifiers | bytes | repeated | Each is 32 bytes |
| Field | Type | Label | Description |
| state_transition | bytes |
|
Compacted address balance change supporting block-aware credit operations
For SetCredits: the final balance value
For AddToCreditsOperations: preserves individual adds with their block heights
| Field | Type | Label | Description |
| address | bytes |
|
|
| set_credits | uint64 | The address balance was set to this value (overwrites previous) |
|
| add_to_credits_operations | AddToCreditsOperations | Individual add-to-credits operations by block height (preserved for partial sync) |
| Field | Type | Label | Description |
| compacted_block_changes | CompactedBlockAddressBalanceChanges | repeated |
|
| Field | Type | Label | Description |
| start_block_height | uint64 |
|
|
| end_block_height | uint64 |
|
|
| changes | CompactedAddressBalanceChange | repeated |
|
| Field | Type | Label | Description |
| start_block_height | uint64 |
|
|
| end_block_height | uint64 |
|
|
| nullifiers | bytes | repeated | Each is 32 bytes |
| Field | Type | Label | Description |
| compacted_block_changes | CompactedBlockNullifierChanges | repeated |
|
| Field | Type | Label | Description |
| v0 | GetAddressInfoRequest.GetAddressInfoRequestV0 |
|
| Field | Type | Label | Description |
| address | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetAddressInfoResponse.GetAddressInfoResponseV0 |
|
| Field | Type | Label | Description |
| address_info_entry | AddressInfoEntry |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetAddressesBranchStateRequest.GetAddressesBranchStateRequestV0 |
|
| Field | Type | Label | Description |
| key | bytes |
|
|
| depth | uint32 |
|
|
| checkpoint_height | uint64 | Block height from trunk response metadata for consistency |
| Field | Type | Label | Description |
| v0 | GetAddressesBranchStateResponse.GetAddressesBranchStateResponseV0 |
|
| Field | Type | Label | Description |
| merk_proof | bytes |
|
| Field | Type | Label | Description |
| v0 | GetAddressesInfosRequest.GetAddressesInfosRequestV0 |
|
| Field | Type | Label | Description |
| addresses | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetAddressesInfosResponse.GetAddressesInfosResponseV0 |
|
| Field | Type | Label | Description |
| address_info_entries | AddressInfoEntries |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetAddressesTrunkStateRequest.GetAddressesTrunkStateRequestV0 |
|
| Field | Type | Label | Description |
| v0 | GetAddressesTrunkStateResponse.GetAddressesTrunkStateResponseV0 |
|
| Field | Type | Label | Description |
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetConsensusParamsRequest.GetConsensusParamsRequestV0 |
|
| Field | Type | Label | Description |
| height | int32 | The blockchain height at which to get the consensus parameters |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetConsensusParamsResponse.GetConsensusParamsResponseV0 |
|
| Field | Type | Label | Description |
| max_bytes | string | The maximum size of a block in bytes |
|
| max_gas | string | The maximum gas allowed in a block |
|
| time_iota_ms | string | The minimum time increment between consecutive |
| Field | Type | Label | Description |
| max_age_num_blocks | string | The maximum age of evidence, in number of blocks |
|
| max_age_duration | string | The maximum age of evidence, as a duration |
|
| max_bytes | string | The maximum size of evidence in bytes |
| Field | Type | Label | Description |
| block | GetConsensusParamsResponse.ConsensusParamsBlock | Consensus parameters related to block creation and validation |
|
| evidence | GetConsensusParamsResponse.ConsensusParamsEvidence | Consensus parameters related to evidence |
How did an identity vote?
| Field | Type | Label | Description |
| v0 | GetContestedResourceIdentityVotesRequest.GetContestedResourceIdentityVotesRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| limit | google.protobuf.UInt32Value |
|
|
| offset | google.protobuf.UInt32Value |
|
|
| order_ascending | bool |
|
|
| start_at_vote_poll_id_info | GetContestedResourceIdentityVotesRequest.GetContestedResourceIdentityVotesRequestV0.StartAtVotePollIdInfo | optional |
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_at_poll_identifier | bytes |
|
|
| start_poll_identifier_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetContestedResourceIdentityVotesResponse.GetContestedResourceIdentityVotesResponseV0 |
|
| Field | Type | Label | Description |
| votes | GetContestedResourceIdentityVotesResponse.GetContestedResourceIdentityVotesResponseV0.ContestedResourceIdentityVotes |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| document_type_name | string |
|
|
| serialized_index_storage_values | bytes | repeated |
|
| vote_choice | GetContestedResourceIdentityVotesResponse.GetContestedResourceIdentityVotesResponseV0.ResourceVoteChoice |
|
| Field | Type | Label | Description |
| contested_resource_identity_votes | GetContestedResourceIdentityVotesResponse.GetContestedResourceIdentityVotesResponseV0.ContestedResourceIdentityVote | repeated |
|
| finished_results | bool |
|
| Field | Type | Label | Description |
| vote_choice_type | GetContestedResourceIdentityVotesResponse.GetContestedResourceIdentityVotesResponseV0.ResourceVoteChoice.VoteChoiceType |
|
|
| identity_id | bytes | optional | Only used when vote_choice_type is TOWARDS_IDENTITY |
What's the state of a contested resource vote? (ie who is winning?)
| Field | Type | Label | Description |
| v0 | GetContestedResourceVoteStateRequest.GetContestedResourceVoteStateRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| document_type_name | string |
|
|
| index_name | string |
|
|
| index_values | bytes | repeated |
|
| result_type | GetContestedResourceVoteStateRequest.GetContestedResourceVoteStateRequestV0.ResultType |
|
|
| allow_include_locked_and_abstaining_vote_tally | bool |
|
|
| start_at_identifier_info | GetContestedResourceVoteStateRequest.GetContestedResourceVoteStateRequestV0.StartAtIdentifierInfo | optional |
|
| count | uint32 | optional |
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_identifier | bytes |
|
|
| start_identifier_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetContestedResourceVoteStateResponse.GetContestedResourceVoteStateResponseV0 |
|
| Field | Type | Label | Description |
| contested_resource_contenders | GetContestedResourceVoteStateResponse.GetContestedResourceVoteStateResponseV0.ContestedResourceContenders |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| identifier | bytes |
|
|
| vote_count | uint32 | optional |
|
| document | bytes | optional |
|
| Field | Type | Label | Description |
| contenders | GetContestedResourceVoteStateResponse.GetContestedResourceVoteStateResponseV0.Contender | repeated |
|
| abstain_vote_tally | uint32 | optional |
|
| lock_vote_tally | uint32 | optional |
|
| finished_vote_info | GetContestedResourceVoteStateResponse.GetContestedResourceVoteStateResponseV0.FinishedVoteInfo | optional |
|
| Field | Type | Label | Description |
| finished_vote_outcome | GetContestedResourceVoteStateResponse.GetContestedResourceVoteStateResponseV0.FinishedVoteInfo.FinishedVoteOutcome |
|
|
| won_by_identity_id | bytes | optional | Only used when vote_choice_type is TOWARDS_IDENTITY |
| finished_at_block_height | uint64 |
|
|
| finished_at_core_block_height | uint32 |
|
|
| finished_at_block_time_ms | uint64 |
|
|
| finished_at_epoch | uint32 |
|
Who voted for a contested resource to go to a specific identity?
| Field | Type | Label | Description |
| v0 | GetContestedResourceVotersForIdentityRequest.GetContestedResourceVotersForIdentityRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| document_type_name | string |
|
|
| index_name | string |
|
|
| index_values | bytes | repeated |
|
| contestant_id | bytes |
|
|
| start_at_identifier_info | GetContestedResourceVotersForIdentityRequest.GetContestedResourceVotersForIdentityRequestV0.StartAtIdentifierInfo | optional |
|
| count | uint32 | optional |
|
| order_ascending | bool |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_identifier | bytes |
|
|
| start_identifier_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetContestedResourceVotersForIdentityResponse.GetContestedResourceVotersForIdentityResponseV0 |
|
| Field | Type | Label | Description |
| contested_resource_voters | GetContestedResourceVotersForIdentityResponse.GetContestedResourceVotersForIdentityResponseV0.ContestedResourceVoters |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| voters | bytes | repeated |
|
| finished_results | bool |
|
| Field | Type | Label | Description |
| v0 | GetContestedResourcesRequest.GetContestedResourcesRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| document_type_name | string |
|
|
| index_name | string |
|
|
| start_index_values | bytes | repeated |
|
| end_index_values | bytes | repeated |
|
| start_at_value_info | GetContestedResourcesRequest.GetContestedResourcesRequestV0.StartAtValueInfo | optional |
|
| count | uint32 | optional |
|
| order_ascending | bool |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_value | bytes |
|
|
| start_value_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetContestedResourcesResponse.GetContestedResourcesResponseV0 |
|
| Field | Type | Label | Description |
| contested_resource_values | GetContestedResourcesResponse.GetContestedResourcesResponseV0.ContestedResourceValues |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| contested_resource_values | bytes | repeated |
|
| Field | Type | Label | Description |
| v0 | GetCurrentQuorumsInfoRequest.GetCurrentQuorumsInfoRequestV0 |
|
| Field | Type | Label | Description |
| v0 | GetCurrentQuorumsInfoResponse.GetCurrentQuorumsInfoResponseV0 |
|
| Field | Type | Label | Description |
| quorum_hashes | bytes | repeated |
|
| current_quorum_hash | bytes |
|
|
| validator_sets | GetCurrentQuorumsInfoResponse.ValidatorSetV0 | repeated |
|
| last_block_proposer | bytes |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| quorum_hash | bytes |
|
|
| core_height | uint32 |
|
|
| members | GetCurrentQuorumsInfoResponse.ValidatorV0 | repeated |
|
| threshold_public_key | bytes |
|
| Field | Type | Label | Description |
| pro_tx_hash | bytes |
|
|
| node_ip | string |
|
|
| is_banned | bool |
|
| Field | Type | Label | Description |
| v0 | GetDataContractHistoryRequest.GetDataContractHistoryRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes | The unique ID of the data contract |
|
| limit | google.protobuf.UInt32Value | The maximum number of history entries to return |
|
| offset | google.protobuf.UInt32Value | The offset for pagination through the contract history |
|
| start_at_ms | uint64 | Only return results starting at this time in milliseconds |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetDataContractHistoryResponse.GetDataContractHistoryResponseV0 |
|
| Field | Type | Label | Description |
| data_contract_history | GetDataContractHistoryResponse.GetDataContractHistoryResponseV0.DataContractHistory | The actual history of the data contract |
|
| proof | Proof | Cryptographic proof of the data contract history, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
Collection of data contract history entries
| Field | Type | Label | Description |
| data_contract_entries | GetDataContractHistoryResponse.GetDataContractHistoryResponseV0.DataContractHistoryEntry | repeated | List of history entries |
Represents a single entry in the data contract's history
| Field | Type | Label | Description |
| date | uint64 | The date of the history entry |
|
| value | bytes | The value of the data contract at this point in history |
| Field | Type | Label | Description |
| v0 | GetDataContractRequest.GetDataContractRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes | The ID of the data contract being requested |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetDataContractResponse.GetDataContractResponseV0 |
|
| Field | Type | Label | Description |
| data_contract | bytes | The actual data contract in binary form |
|
| proof | Proof | Cryptographic proof of the data contract, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| v0 | GetDataContractsRequest.GetDataContractsRequestV0 |
|
| Field | Type | Label | Description |
| ids | bytes | repeated | A list of unique IDs for the data contracts being requested |
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetDataContractsResponse.GetDataContractsResponseV0 |
|
| Field | Type | Label | Description |
| identifier | bytes | The unique identifier of the data contract |
|
| data_contract | google.protobuf.BytesValue | The actual data contract content |
DataContracts is a collection of data contract entries.
| Field | Type | Label | Description |
| data_contract_entries | GetDataContractsResponse.DataContractEntry | repeated | A list of data contract entries |
| Field | Type | Label | Description |
| data_contracts | GetDataContractsResponse.DataContracts | The actual data contracts requested |
|
| proof | Proof | Cryptographic proof for the data contracts, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| v0 | GetDocumentsRequest.GetDocumentsRequestV0 |
|
| Field | Type | Label | Description |
| data_contract_id | bytes | The ID of the data contract containing the documents |
|
| document_type | string | The type of document being requested |
|
| where | bytes | Conditions to be met by the requested documents |
|
| order_by | bytes | Ordering criteria for the documents |
|
| limit | uint32 | Maximum number of documents to return |
|
| start_after | bytes | Start retrieval after this document |
|
| start_at | bytes | Start retrieval at this document |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetDocumentsResponse.GetDocumentsResponseV0 |
|
| Field | Type | Label | Description |
| documents | GetDocumentsResponse.GetDocumentsResponseV0.Documents | The actual documents requested |
|
| proof | Proof | Cryptographic proof of the documents, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
Represents a collection of documents
| Field | Type | Label | Description |
| documents | bytes | repeated | The actual documents in binary form |
| Field | Type | Label | Description |
| v0 | GetEpochsInfoRequest.GetEpochsInfoRequestV0 |
|
| Field | Type | Label | Description |
| start_epoch | google.protobuf.UInt32Value | The starting epoch for the request |
|
| count | uint32 | The number of epochs to retrieve information for |
|
| ascending | bool | Flag indicating if the epochs should be listed in ascending order |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetEpochsInfoResponse.GetEpochsInfoResponseV0 |
|
| Field | Type | Label | Description |
| epochs | GetEpochsInfoResponse.GetEpochsInfoResponseV0.EpochInfos | The actual information about the requested epochs |
|
| proof | Proof | Cryptographic proof of the epoch information, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
EpochInfo represents information about a single epoch
| Field | Type | Label | Description |
| number | uint32 | The number of the epoch |
|
| first_block_height | uint64 | The height of the first block in this epoch |
|
| first_core_block_height | uint32 | The height of the first Core block in this epoch |
|
| start_time | uint64 | The start time of the epoch |
|
| fee_multiplier | double | The fee multiplier applicable in this epoch |
|
| protocol_version | uint32 |
|
EpochInfos holds a collection of epoch information entries
| Field | Type | Label | Description |
| epoch_infos | GetEpochsInfoResponse.GetEpochsInfoResponseV0.EpochInfo | repeated | List of information for each requested epoch |
| Field | Type | Label | Description |
| v0 | GetEvonodesProposedEpochBlocksByIdsRequest.GetEvonodesProposedEpochBlocksByIdsRequestV0 |
|
| Field | Type | Label | Description |
| epoch | uint32 | optional | The epoch we are querying for, if none is set, get current epoch |
| ids | bytes | repeated | IDs of the evonodes for which we want to get their proposed blocks |
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetEvonodesProposedEpochBlocksByRangeRequest.GetEvonodesProposedEpochBlocksByRangeRequestV0 |
|
| Field | Type | Label | Description |
| epoch | uint32 | optional | The epoch we are querying for, if none is set, get current epoch |
| limit | uint32 | optional | Maximum number of evonodes proposed epoch blocks to return |
| start_after | bytes | Start retrieval after this document |
|
| start_at | bytes | Start retrieval at this document |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetEvonodesProposedEpochBlocksResponse.GetEvonodesProposedEpochBlocksResponseV0 |
|
| Field | Type | Label | Description |
| evonodes_proposed_block_counts_info | GetEvonodesProposedEpochBlocksResponse.GetEvonodesProposedEpochBlocksResponseV0.EvonodesProposedBlocks | The actual result |
|
| proof | Proof | Proof of the keys data, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| pro_tx_hash | bytes |
|
|
| count | uint64 |
|
| Field | Type | Label | Description |
| evonodes_proposed_block_counts | GetEvonodesProposedEpochBlocksResponse.GetEvonodesProposedEpochBlocksResponseV0.EvonodeProposedBlocks | repeated |
|
| Field | Type | Label | Description |
| v0 | GetFinalizedEpochInfosRequest.GetFinalizedEpochInfosRequestV0 |
|
| Field | Type | Label | Description |
| start_epoch_index | uint32 | The starting epoch index |
|
| start_epoch_index_included | bool | Whether to include the start epoch |
|
| end_epoch_index | uint32 | The ending epoch index |
|
| end_epoch_index_included | bool | Whether to include the end epoch |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetFinalizedEpochInfosResponse.GetFinalizedEpochInfosResponseV0 |
|
| Field | Type | Label | Description |
| epochs | GetFinalizedEpochInfosResponse.GetFinalizedEpochInfosResponseV0.FinalizedEpochInfos | The actual finalized information about the requested epochs |
|
| proof | Proof | Cryptographic proof of the finalized epoch |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
BlockProposer represents a block proposer and their block count
| Field | Type | Label | Description |
| proposer_id | bytes | The proposer's identifier |
|
| block_count | uint32 | Number of blocks proposed |
FinalizedEpochInfo represents finalized information about a single epoch
| Field | Type | Label | Description |
| number | uint32 | The number of the epoch |
|
| first_block_height | uint64 | The height of the first block in this epoch |
|
| first_core_block_height | uint32 | The height of the first Core block in this epoch |
|
| first_block_time | uint64 | The timestamp of the first block (milliseconds) |
|
| fee_multiplier | double | The fee multiplier (converted from permille) |
|
| protocol_version | uint32 | The protocol version for this epoch |
|
| total_blocks_in_epoch | uint64 | Total number of blocks in the epoch |
|
| next_epoch_start_core_block_height | uint32 | Core block height where next epoch starts |
|
| total_processing_fees | uint64 | Total processing fees collected |
|
| total_distributed_storage_fees | uint64 | Total storage fees distributed |
|
| total_created_storage_fees | uint64 | Total storage fees created |
|
| core_block_rewards | uint64 | Rewards from core blocks |
|
| block_proposers | GetFinalizedEpochInfosResponse.GetFinalizedEpochInfosResponseV0.BlockProposer | repeated | List of block proposers and their counts |
FinalizedEpochInfos holds a collection of finalized epoch information
entries
| Field | Type | Label | Description |
| finalized_epoch_infos | GetFinalizedEpochInfosResponse.GetFinalizedEpochInfosResponseV0.FinalizedEpochInfo | repeated | List of finalized information for each requested epoch |
| Field | Type | Label | Description |
| v0 | GetGroupActionSignersRequest.GetGroupActionSignersRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| group_contract_position | uint32 |
|
|
| status | GetGroupActionSignersRequest.ActionStatus |
|
|
| action_id | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetGroupActionSignersResponse.GetGroupActionSignersResponseV0 |
|
| Field | Type | Label | Description |
| group_action_signers | GetGroupActionSignersResponse.GetGroupActionSignersResponseV0.GroupActionSigners |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| signer_id | bytes |
|
|
| power | uint32 |
|
| Field | Type | Label | Description |
| signers | GetGroupActionSignersResponse.GetGroupActionSignersResponseV0.GroupActionSigner | repeated |
|
| Field | Type | Label | Description |
| v0 | GetGroupActionsRequest.GetGroupActionsRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| group_contract_position | uint32 |
|
|
| status | GetGroupActionsRequest.ActionStatus |
|
|
| start_at_action_id | GetGroupActionsRequest.StartAtActionId | optional |
|
| count | uint32 | optional |
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_action_id | bytes |
|
|
| start_action_id_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetGroupActionsResponse.GetGroupActionsResponseV0 |
|
| Field | Type | Label | Description |
| group_actions | GetGroupActionsResponse.GetGroupActionsResponseV0.GroupActions |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
Burn event
| Field | Type | Label | Description |
| amount | uint64 | Amount to burn |
|
| burn_from_id | bytes | The identifier to burn from |
|
| public_note | string | optional | Public note |
| Field | Type | Label | Description |
| update | GetGroupActionsResponse.GetGroupActionsResponseV0.ContractUpdateEvent | Contract update event |
| Field | Type | Label | Description |
| updated_contract | bytes |
|
Destroy frozen funds event
| Field | Type | Label | Description |
| frozen_id | bytes | Identifier of the frozen entity |
|
| amount | uint64 | Amount to destroy |
|
| public_note | string | optional | Public note |
| Field | Type | Label | Description |
| created_document | bytes |
|
| Field | Type | Label | Description |
| create | GetGroupActionsResponse.GetGroupActionsResponseV0.DocumentCreateEvent | Create event details |
Emergency action event
| Field | Type | Label | Description |
| action_type | GetGroupActionsResponse.GetGroupActionsResponseV0.EmergencyActionEvent.ActionType | Emergency action type |
|
| public_note | string | optional | Public note |
Freeze event
| Field | Type | Label | Description |
| frozen_id | bytes | Identifier of the frozen entity |
|
| public_note | string | optional | Public note |
| Field | Type | Label | Description |
| action_id | bytes | Unique identifier for the action |
|
| event | GetGroupActionsResponse.GetGroupActionsResponseV0.GroupActionEvent | The event data |
Event associated with this action
| Field | Type | Label | Description |
| token_event | GetGroupActionsResponse.GetGroupActionsResponseV0.TokenEvent | Token event details |
|
| document_event | GetGroupActionsResponse.GetGroupActionsResponseV0.DocumentEvent |
|
|
| contract_event | GetGroupActionsResponse.GetGroupActionsResponseV0.ContractEvent |
|
| Field | Type | Label | Description |
| group_actions | GetGroupActionsResponse.GetGroupActionsResponseV0.GroupActionEntry | repeated |
|
Mint event
| Field | Type | Label | Description |
| amount | uint64 | Amount to mint |
|
| recipient_id | bytes | Recipient identifier |
|
| public_note | string | optional | Public note |
Personal encrypted note
| Field | Type | Label | Description |
| root_encryption_key_index | uint32 | Root encryption key index |
|
| derivation_encryption_key_index | uint32 | Derivation encryption key index |
|
| encrypted_data | bytes | Encrypted data |
Shared encrypted note
| Field | Type | Label | Description |
| sender_key_index | uint32 | Sender key index |
|
| recipient_key_index | uint32 | Recipient key index |
|
| encrypted_data | bytes | Encrypted data |
Token config update event
| Field | Type | Label | Description |
| token_config_update_item | bytes | Token config update item |
|
| public_note | string | optional | Public note |
Details for token events
| Field | Type | Label | Description |
| mint | GetGroupActionsResponse.GetGroupActionsResponseV0.MintEvent | Mint event details |
|
| burn | GetGroupActionsResponse.GetGroupActionsResponseV0.BurnEvent | Burn event details |
|
| freeze | GetGroupActionsResponse.GetGroupActionsResponseV0.FreezeEvent | Freeze event details |
|
| unfreeze | GetGroupActionsResponse.GetGroupActionsResponseV0.UnfreezeEvent | Unfreeze event details |
|
| destroy_frozen_funds | GetGroupActionsResponse.GetGroupActionsResponseV0.DestroyFrozenFundsEvent | Destroy frozen funds |
|
| emergency_action | GetGroupActionsResponse.GetGroupActionsResponseV0.EmergencyActionEvent | Emergency action details |
|
| token_config_update | GetGroupActionsResponse.GetGroupActionsResponseV0.TokenConfigUpdateEvent | Token configuration update details |
|
| update_price | GetGroupActionsResponse.GetGroupActionsResponseV0.UpdateDirectPurchasePriceEvent | Updating the token direct selling price |
Unfreeze event
| Field | Type | Label | Description |
| frozen_id | bytes | Identifier of the unfrozen entity |
|
| public_note | string | optional | Public note |
UpdatePrice event
| Field | Type | Label | Description |
| fixed_price | uint64 |
|
|
| variable_price | GetGroupActionsResponse.GetGroupActionsResponseV0.UpdateDirectPurchasePriceEvent.PricingSchedule |
|
|
| public_note | string | optional | Public note |
| Field | Type | Label | Description |
| quantity | uint64 |
|
|
| price | uint64 |
|
| Field | Type | Label | Description |
| price_for_quantity | GetGroupActionsResponse.GetGroupActionsResponseV0.UpdateDirectPurchasePriceEvent.PriceForQuantity | repeated |
|
| Field | Type | Label | Description |
| v0 | GetGroupInfoRequest.GetGroupInfoRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| group_contract_position | uint32 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetGroupInfoResponse.GetGroupInfoResponseV0 |
|
| Field | Type | Label | Description |
| group_info | GetGroupInfoResponse.GetGroupInfoResponseV0.GroupInfo |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| group_info | GetGroupInfoResponse.GetGroupInfoResponseV0.GroupInfoEntry | optional |
|
| Field | Type | Label | Description |
| members | GetGroupInfoResponse.GetGroupInfoResponseV0.GroupMemberEntry | repeated |
|
| group_required_power | uint32 |
|
| Field | Type | Label | Description |
| member_id | bytes |
|
|
| power | uint32 |
|
| Field | Type | Label | Description |
| v0 | GetGroupInfosRequest.GetGroupInfosRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| start_at_group_contract_position | GetGroupInfosRequest.StartAtGroupContractPosition | optional |
|
| count | uint32 | optional |
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_group_contract_position | uint32 |
|
|
| start_group_contract_position_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetGroupInfosResponse.GetGroupInfosResponseV0 |
|
| Field | Type | Label | Description |
| group_infos | GetGroupInfosResponse.GetGroupInfosResponseV0.GroupInfos |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| group_infos | GetGroupInfosResponse.GetGroupInfosResponseV0.GroupPositionInfoEntry | repeated |
|
| Field | Type | Label | Description |
| member_id | bytes |
|
|
| power | uint32 |
|
| Field | Type | Label | Description |
| group_contract_position | uint32 |
|
|
| members | GetGroupInfosResponse.GetGroupInfosResponseV0.GroupMemberEntry | repeated |
|
| group_required_power | uint32 |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesBalancesRequest.GetIdentitiesBalancesRequestV0 |
|
| Field | Type | Label | Description |
| ids | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesBalancesResponse.GetIdentitiesBalancesResponseV0 |
|
| Field | Type | Label | Description |
| identities_balances | GetIdentitiesBalancesResponse.GetIdentitiesBalancesResponseV0.IdentitiesBalances |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| entries | GetIdentitiesBalancesResponse.GetIdentitiesBalancesResponseV0.IdentityBalance | repeated |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| balance | uint64 | optional |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesContractKeysRequest.GetIdentitiesContractKeysRequestV0 |
|
| Field | Type | Label | Description |
| identities_ids | bytes | repeated |
|
| contract_id | bytes |
|
|
| document_type_name | string | optional |
|
| purposes | KeyPurpose | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesContractKeysResponse.GetIdentitiesContractKeysResponseV0 |
|
| Field | Type | Label | Description |
| identities_keys | GetIdentitiesContractKeysResponse.GetIdentitiesContractKeysResponseV0.IdentitiesKeys |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| entries | GetIdentitiesContractKeysResponse.GetIdentitiesContractKeysResponseV0.IdentityKeys | repeated |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| keys | GetIdentitiesContractKeysResponse.GetIdentitiesContractKeysResponseV0.PurposeKeys | repeated |
|
| Field | Type | Label | Description |
| purpose | KeyPurpose |
|
|
| keys_bytes | bytes | repeated |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesTokenBalancesRequest.GetIdentitiesTokenBalancesRequestV0 |
|
| Field | Type | Label | Description |
| token_id | bytes | Token ID |
|
| identity_ids | bytes | repeated | List of identity IDs |
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentitiesTokenBalancesResponse.GetIdentitiesTokenBalancesResponseV0 |
|
| Field | Type | Label | Description |
| identity_token_balances | GetIdentitiesTokenBalancesResponse.GetIdentitiesTokenBalancesResponseV0.IdentityTokenBalances | Actual identity token balances |
|
| proof | Proof | Proof of the balances, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| identity_id | bytes | Identity ID |
|
| balance | uint64 | optional | Token balance for the identity |
| Field | Type | Label | Description |
| identity_token_balances | GetIdentitiesTokenBalancesResponse.GetIdentitiesTokenBalancesResponseV0.IdentityTokenBalanceEntry | repeated | List of identity token balances |
| Field | Type | Label | Description |
| v0 | GetIdentitiesTokenInfosRequest.GetIdentitiesTokenInfosRequestV0 |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| identity_ids | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentitiesTokenInfosResponse.GetIdentitiesTokenInfosResponseV0 |
|
| Field | Type | Label | Description |
| identity_token_infos | GetIdentitiesTokenInfosResponse.GetIdentitiesTokenInfosResponseV0.IdentityTokenInfos |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| token_infos | GetIdentitiesTokenInfosResponse.GetIdentitiesTokenInfosResponseV0.TokenInfoEntry | repeated |
|
| Field | Type | Label | Description |
| frozen | bool |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| info | GetIdentitiesTokenInfosResponse.GetIdentitiesTokenInfosResponseV0.TokenIdentityInfoEntry | optional |
|
| Field | Type | Label | Description |
| v0 | GetIdentityBalanceAndRevisionRequest.GetIdentityBalanceAndRevisionRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes | ID of the identity for balance and revision |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityBalanceAndRevisionResponse.GetIdentityBalanceAndRevisionResponseV0 |
|
| Field | Type | Label | Description |
| balance_and_revision | GetIdentityBalanceAndRevisionResponse.GetIdentityBalanceAndRevisionResponseV0.BalanceAndRevision | The balance and revision data |
|
| proof | Proof | Proof of the data, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| balance | uint64 | Balance of the identity |
|
| revision | uint64 | Revision number of the identity |
| Field | Type | Label | Description |
| v0 | GetIdentityBalanceRequest.GetIdentityBalanceRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes | ID of the identity whose balance is requested |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityBalanceResponse.GetIdentityBalanceResponseV0 |
|
| Field | Type | Label | Description |
| balance | uint64 | The balance of the requested identity |
|
| proof | Proof | Proof of the balance, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| v0 | GetIdentityByNonUniquePublicKeyHashRequest.GetIdentityByNonUniquePublicKeyHashRequestV0 |
|
| Field | Type | Label | Description |
| public_key_hash | bytes |
|
|
| start_after | bytes | optional | Give one result after a previous result |
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentityByNonUniquePublicKeyHashResponse.GetIdentityByNonUniquePublicKeyHashResponseV0 |
|
| Field | Type | Label | Description |
| identity | GetIdentityByNonUniquePublicKeyHashResponse.GetIdentityByNonUniquePublicKeyHashResponseV0.IdentityResponse |
|
|
| proof | GetIdentityByNonUniquePublicKeyHashResponse.GetIdentityByNonUniquePublicKeyHashResponseV0.IdentityProvedResponse |
|
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| grovedb_identity_public_key_hash_proof | Proof |
|
|
| identity_proof_bytes | bytes | optional | A hack, we return 2 proofs |
| Field | Type | Label | Description |
| identity | bytes | optional |
|
| Field | Type | Label | Description |
| v0 | GetIdentityByPublicKeyHashRequest.GetIdentityByPublicKeyHashRequestV0 |
|
| Field | Type | Label | Description |
| public_key_hash | bytes | The public key hash of the identity being requested |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityByPublicKeyHashResponse.GetIdentityByPublicKeyHashResponseV0 |
|
| Field | Type | Label | Description |
| identity | bytes | The actual identity data corresponding to the |
|
| proof | Proof | requested public key hash Cryptographic proof for the identity data, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| v0 | GetIdentityContractNonceRequest.GetIdentityContractNonceRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| contract_id | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentityContractNonceResponse.GetIdentityContractNonceResponseV0 |
|
| Field | Type | Label | Description |
| identity_contract_nonce | uint64 |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetIdentityKeysRequest.GetIdentityKeysRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes | ID of the identity for key retrieval |
|
| request_type | KeyRequestType | Type of key request: all, specific, or search |
|
| limit | google.protobuf.UInt32Value | Limit on the number of keys to be returned |
|
| offset | google.protobuf.UInt32Value | Offset for pagination through the keys |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityKeysResponse.GetIdentityKeysResponseV0 |
|
| Field | Type | Label | Description |
| keys | GetIdentityKeysResponse.GetIdentityKeysResponseV0.Keys | The actual key data |
|
| proof | Proof | Proof of the keys data, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| keys_bytes | bytes | repeated |
|
| Field | Type | Label | Description |
| v0 | GetIdentityNonceRequest.GetIdentityNonceRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentityNonceResponse.GetIdentityNonceResponseV0 |
|
| Field | Type | Label | Description |
| identity_nonce | uint64 |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetIdentityRequest.GetIdentityRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes | The ID of the identity being requested |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityResponse.GetIdentityResponseV0 |
|
| Field | Type | Label | Description |
| identity | bytes | The requested identity data |
|
| proof | Proof | Proof of the identity data, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| v0 | GetIdentityTokenBalancesRequest.GetIdentityTokenBalancesRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes | ID of the identity |
|
| token_ids | bytes | repeated | List of token IDs |
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetIdentityTokenBalancesResponse.GetIdentityTokenBalancesResponseV0 |
|
| Field | Type | Label | Description |
| token_balances | GetIdentityTokenBalancesResponse.GetIdentityTokenBalancesResponseV0.TokenBalances | Actual token balances |
|
| proof | Proof | Proof of the token balances, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Field | Type | Label | Description |
| token_id | bytes | Token ID |
|
| balance | uint64 | optional | Token balance for the contract |
| Field | Type | Label | Description |
| token_balances | GetIdentityTokenBalancesResponse.GetIdentityTokenBalancesResponseV0.TokenBalanceEntry | repeated | List of token balances |
| Field | Type | Label | Description |
| v0 | GetIdentityTokenInfosRequest.GetIdentityTokenInfosRequestV0 |
|
| Field | Type | Label | Description |
| identity_id | bytes |
|
|
| token_ids | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetIdentityTokenInfosResponse.GetIdentityTokenInfosResponseV0 |
|
| Field | Type | Label | Description |
| token_infos | GetIdentityTokenInfosResponse.GetIdentityTokenInfosResponseV0.TokenInfos |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| frozen | bool |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| info | GetIdentityTokenInfosResponse.GetIdentityTokenInfosResponseV0.TokenIdentityInfoEntry | optional |
|
| Field | Type | Label | Description |
| token_infos | GetIdentityTokenInfosResponse.GetIdentityTokenInfosResponseV0.TokenInfoEntry | repeated |
|
| Field | Type | Label | Description |
| v0 | GetMostRecentShieldedAnchorRequest.GetMostRecentShieldedAnchorRequestV0 |
|
| Field | Type | Label | Description |
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetMostRecentShieldedAnchorResponse.GetMostRecentShieldedAnchorResponseV0 |
|
| Field | Type | Label | Description |
| anchor | bytes |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetNullifiersBranchStateRequest.GetNullifiersBranchStateRequestV0 |
|
| Field | Type | Label | Description |
| pool_type | uint32 |
|
|
| pool_identifier | bytes |
|
|
| key | bytes |
|
|
| depth | uint32 |
|
|
| checkpoint_height | uint64 |
|
| Field | Type | Label | Description |
| v0 | GetNullifiersBranchStateResponse.GetNullifiersBranchStateResponseV0 |
|
| Field | Type | Label | Description |
| merk_proof | bytes |
|
| Field | Type | Label | Description |
| v0 | GetNullifiersTrunkStateRequest.GetNullifiersTrunkStateRequestV0 |
|
| Field | Type | Label | Description |
| pool_type | uint32 | ShieldedPoolType enum value (0=credit, 1=main token, 2=individual token) |
|
| pool_identifier | bytes | 32-byte Identifier, required for pool_type=2 |
| Field | Type | Label | Description |
| v0 | GetNullifiersTrunkStateResponse.GetNullifiersTrunkStateResponseV0 |
|
| Field | Type | Label | Description |
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetPathElementsRequest.GetPathElementsRequestV0 |
|
| Field | Type | Label | Description |
| path | bytes | repeated |
|
| keys | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetPathElementsResponse.GetPathElementsResponseV0 |
|
| Field | Type | Label | Description |
| elements | GetPathElementsResponse.GetPathElementsResponseV0.Elements |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| elements | bytes | repeated |
|
| Field | Type | Label | Description |
| v0 | GetPrefundedSpecializedBalanceRequest.GetPrefundedSpecializedBalanceRequestV0 |
|
| Field | Type | Label | Description |
| id | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetPrefundedSpecializedBalanceResponse.GetPrefundedSpecializedBalanceResponseV0 |
|
| Field | Type | Label | Description |
| balance | uint64 |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetProtocolVersionUpgradeStateRequest.GetProtocolVersionUpgradeStateRequestV0 |
|
| Field | Type | Label | Description |
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetProtocolVersionUpgradeStateResponse.GetProtocolVersionUpgradeStateResponseV0 |
|
| Field | Type | Label | Description |
| versions | GetProtocolVersionUpgradeStateResponse.GetProtocolVersionUpgradeStateResponseV0.Versions | The actual protocol version information |
|
| proof | Proof | Cryptographic proof of the protocol version |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
VersionEntry represents a single entry of a protocol version
| Field | Type | Label | Description |
| version_number | uint32 | The protocol version number |
|
| vote_count | uint32 | The vote count for this protocol version |
Versions holds a collection of version entries
| Field | Type | Label | Description |
| versions | GetProtocolVersionUpgradeStateResponse.GetProtocolVersionUpgradeStateResponseV0.VersionEntry | repeated | List of protocol version entries |
| Field | Type | Label | Description |
| v0 | GetProtocolVersionUpgradeVoteStatusRequest.GetProtocolVersionUpgradeVoteStatusRequestV0 |
|
| Field | Type | Label | Description |
| start_pro_tx_hash | bytes | The starting masternode provider transaction |
|
| count | uint32 | hash to filter the votes by The number of vote entries to retrieve |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | GetProtocolVersionUpgradeVoteStatusResponse.GetProtocolVersionUpgradeVoteStatusResponseV0 |
|
| Field | Type | Label | Description |
| versions | GetProtocolVersionUpgradeVoteStatusResponse.GetProtocolVersionUpgradeVoteStatusResponseV0.VersionSignals | The actual version signal information |
|
| proof | Proof | Cryptographic proof of the version signal information, |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
VersionSignal represents a single voting signal for a protocol version
| Field | Type | Label | Description |
| pro_tx_hash | bytes | The masternode provider transaction hash |
|
| version | uint32 | associated with the vote The protocol version number that is being voted on |
VersionSignals holds a collection of version signal entries
| Field | Type | Label | Description |
| version_signals | GetProtocolVersionUpgradeVoteStatusResponse.GetProtocolVersionUpgradeVoteStatusResponseV0.VersionSignal | repeated | List of version signal entries |
| Field | Type | Label | Description |
| v0 | GetRecentAddressBalanceChangesRequest.GetRecentAddressBalanceChangesRequestV0 |
|
| Field | Type | Label | Description |
| start_height | uint64 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetRecentAddressBalanceChangesResponse.GetRecentAddressBalanceChangesResponseV0 |
|
| Field | Type | Label | Description |
| address_balance_update_entries | AddressBalanceUpdateEntries |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetRecentCompactedAddressBalanceChangesRequest.GetRecentCompactedAddressBalanceChangesRequestV0 |
|
| Field | Type | Label | Description |
| start_block_height | uint64 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetRecentCompactedAddressBalanceChangesResponse.GetRecentCompactedAddressBalanceChangesResponseV0 |
|
| Field | Type | Label | Description |
| compacted_address_balance_update_entries | CompactedAddressBalanceUpdateEntries |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetRecentCompactedNullifierChangesRequest.GetRecentCompactedNullifierChangesRequestV0 |
|
| Field | Type | Label | Description |
| start_block_height | uint64 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetRecentCompactedNullifierChangesResponse.GetRecentCompactedNullifierChangesResponseV0 |
|
| Field | Type | Label | Description |
| compacted_nullifier_update_entries | CompactedNullifierUpdateEntries |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetRecentNullifierChangesRequest.GetRecentNullifierChangesRequestV0 |
|
| Field | Type | Label | Description |
| start_height | uint64 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetRecentNullifierChangesResponse.GetRecentNullifierChangesResponseV0 |
|
| Field | Type | Label | Description |
| nullifier_update_entries | NullifierUpdateEntries |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetShieldedAnchorsRequest.GetShieldedAnchorsRequestV0 |
|
| Field | Type | Label | Description |
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetShieldedAnchorsResponse.GetShieldedAnchorsResponseV0 |
|
| Field | Type | Label | Description |
| anchors | GetShieldedAnchorsResponse.GetShieldedAnchorsResponseV0.Anchors |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| anchors | bytes | repeated |
|
| Field | Type | Label | Description |
| v0 | GetShieldedEncryptedNotesRequest.GetShieldedEncryptedNotesRequestV0 |
|
| Field | Type | Label | Description |
| start_index | uint64 |
|
|
| count | uint32 |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetShieldedEncryptedNotesResponse.GetShieldedEncryptedNotesResponseV0 |
|
| Field | Type | Label | Description |
| encrypted_notes | GetShieldedEncryptedNotesResponse.GetShieldedEncryptedNotesResponseV0.EncryptedNotes |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| nullifier | bytes | 32-byte nullifier (needed for Rho derivation in trial decryption) |
|
| cmx | bytes | 32-byte extracted note commitment |
|
| encrypted_note | bytes | encrypted note payload (epk + enc_ciphertext + out_ciphertext) |
| Field | Type | Label | Description |
| entries | GetShieldedEncryptedNotesResponse.GetShieldedEncryptedNotesResponseV0.EncryptedNote | repeated |
|
| Field | Type | Label | Description |
| v0 | GetShieldedNullifiersRequest.GetShieldedNullifiersRequestV0 |
|
| Field | Type | Label | Description |
| nullifiers | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetShieldedNullifiersResponse.GetShieldedNullifiersResponseV0 |
|
| Field | Type | Label | Description |
| nullifier_statuses | GetShieldedNullifiersResponse.GetShieldedNullifiersResponseV0.NullifierStatuses |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| nullifier | bytes |
|
|
| is_spent | bool |
|
| Field | Type | Label | Description |
| entries | GetShieldedNullifiersResponse.GetShieldedNullifiersResponseV0.NullifierStatus | repeated |
|
| Field | Type | Label | Description |
| v0 | GetShieldedPoolStateRequest.GetShieldedPoolStateRequestV0 |
|
| Field | Type | Label | Description |
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetShieldedPoolStateResponse.GetShieldedPoolStateResponseV0 |
|
| Field | Type | Label | Description |
| total_balance | uint64 |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetStatusRequest.GetStatusRequestV0 |
|
| Field | Type | Label | Description |
| v0 | GetStatusResponse.GetStatusResponseV0 |
|
| Field | Type | Label | Description |
| version | GetStatusResponse.GetStatusResponseV0.Version |
|
|
| node | GetStatusResponse.GetStatusResponseV0.Node |
|
|
| chain | GetStatusResponse.GetStatusResponseV0.Chain |
|
|
| network | GetStatusResponse.GetStatusResponseV0.Network |
|
|
| state_sync | GetStatusResponse.GetStatusResponseV0.StateSync |
|
|
| time | GetStatusResponse.GetStatusResponseV0.Time |
|
| Field | Type | Label | Description |
| catching_up | bool |
|
|
| latest_block_hash | bytes |
|
|
| latest_app_hash | bytes |
|
|
| latest_block_height | uint64 |
|
|
| earliest_block_hash | bytes |
|
|
| earliest_app_hash | bytes |
|
|
| earliest_block_height | uint64 |
|
|
| max_peer_block_height | uint64 |
|
|
| core_chain_locked_height | uint32 | optional | Latest known core height in consensus. It will be missing if Drive is not responding |
| Field | Type | Label | Description |
| chain_id | string |
|
|
| peers_count | uint32 |
|
|
| listening | bool |
|
| Field | Type | Label | Description |
| id | bytes | Platform node ID |
|
| pro_tx_hash | bytes | optional | Evo masternode pro tx hash. It will be absent if the node is a fullnode |
| Field | Type | Label | Description |
| total_synced_time | uint64 |
|
|
| remaining_time | uint64 |
|
|
| total_snapshots | uint32 |
|
|
| chunk_process_avg_time | uint64 |
|
|
| snapshot_height | uint64 |
|
|
| snapshot_chunks_count | uint64 |
|
|
| backfilled_blocks | uint64 |
|
|
| backfill_blocks_total | uint64 |
|
| Field | Type | Label | Description |
| local | uint64 |
|
|
| block | uint64 | optional | It will be missing if Drive is not responding |
| genesis | uint64 | optional | It will be missing if Drive is not responding |
| epoch | uint32 | optional | It will be missing if Drive is not responding |
| Field | Type | Label | Description |
| software | GetStatusResponse.GetStatusResponseV0.Version.Software |
|
|
| protocol | GetStatusResponse.GetStatusResponseV0.Version.Protocol |
|
| Field | Type | Label | Description |
| tenderdash | GetStatusResponse.GetStatusResponseV0.Version.Protocol.Tenderdash |
|
|
| drive | GetStatusResponse.GetStatusResponseV0.Version.Protocol.Drive |
|
| Field | Type | Label | Description |
| latest | uint32 | Highest protocol version supported by this node |
|
| current | uint32 | Protocol version used in current epoch |
|
| next_epoch | uint32 | Protocol version that will be used in the next epoch |
| Field | Type | Label | Description |
| p2p | uint32 |
|
|
| block | uint32 |
|
| Field | Type | Label | Description |
| dapi | string |
|
|
| drive | string | optional | It will be missing if Drive is not responding |
| tenderdash | string | optional | It will be missing if Tenderdash is not responding |
Request to retrieve token contract info for a specific token ID.
| Field | Type | Label | Description |
| v0 | GetTokenContractInfoRequest.GetTokenContractInfoRequestV0 |
|
| Field | Type | Label | Description |
| token_id | bytes | The token ID to retrieve contract info for. Must be exactly 32 bytes. |
|
| prove | bool | Whether to return a cryptographic proof. |
Response to GetTokenContractInfoRequest.
| Field | Type | Label | Description |
| v0 | GetTokenContractInfoResponse.GetTokenContractInfoResponseV0 |
|
| Field | Type | Label | Description |
| data | GetTokenContractInfoResponse.GetTokenContractInfoResponseV0.TokenContractInfoData | Direct token contract data |
|
| proof | Proof | Cryptographic proof of token contract info |
|
| metadata | ResponseMetadata | Metadata about the blockchain state at the time of the query |
Direct token contract info.
| Field | Type | Label | Description |
| contract_id | bytes | The ID of the contract associated with the token. |
|
| token_contract_position | uint32 | The position of the token within the contract. |
Retrieve direct purchase prices defined for one or more tokens.
Some tokens can have a direct purchase price defined using
`TokenSetPriceForDirectPurchaseTransition` (see `dpp` crate for details).
This request retrieves the direct purchase prices for those tokens and
returns [GetTokenDirectPurchasePricesResponse].
| Field | Type | Label | Description |
| v0 | GetTokenDirectPurchasePricesRequest.GetTokenDirectPurchasePricesRequestV0 |
|
| Field | Type | Label | Description |
| token_ids | bytes | repeated | List of token IDs to get prices for. The list must not be empty. Token IDs must have 32 bytes and be unique. Results for non-unique token IDs are undefined. |
| prove | bool | Whether to return proofs for the response, or just direct response. |
Response to GetTokenDirectPurchasePricesRequest, containing information about
direct purchase prices defined for requested token IDs.
| Field | Type | Label | Description |
| v0 | GetTokenDirectPurchasePricesResponse.GetTokenDirectPurchasePricesResponseV0 |
|
| Field | Type | Label | Description |
| token_direct_purchase_prices | GetTokenDirectPurchasePricesResponse.GetTokenDirectPurchasePricesResponseV0.TokenDirectPurchasePrices | Contains the list of token IDs and their corresponding direct |
|
| proof | Proof | Requested information in a form of cryptographic proof. In Rust, use `FromProof` trait to convert it to the actual data. |
|
| metadata | ResponseMetadata | Metadata about the blockchain state. |
Contains the individual price tier for a specific quantity of tokens.
| Field | Type | Label | Description |
| quantity | uint64 | Minimum quantity of tokens to purchase to get this price. |
|
| price | uint64 | Price for the specified quantity of tokens. |
Contains list of price tiers for a specific token.
| Field | Type | Label | Description |
| price_for_quantity | GetTokenDirectPurchasePricesResponse.GetTokenDirectPurchasePricesResponseV0.PriceForQuantity | repeated |
|
| Field | Type | Label | Description |
| token_id | bytes | 32-byte token identifier |
|
| fixed_price | uint64 | Fixed price for the token. |
|
| variable_price | GetTokenDirectPurchasePricesResponse.GetTokenDirectPurchasePricesResponseV0.PricingSchedule | Tiered pricing for the token, where the price varies based on the quantity purchased. |
For each requested token, contains list of token IDs and their
corresponding direct purchase prices.
| Field | Type | Label | Description |
| token_direct_purchase_price | GetTokenDirectPurchasePricesResponse.GetTokenDirectPurchasePricesResponseV0.TokenDirectPurchasePriceEntry | repeated |
|
| Field | Type | Label | Description |
| v0 | GetTokenPerpetualDistributionLastClaimRequest.GetTokenPerpetualDistributionLastClaimRequestV0 |
|
| Field | Type | Label | Description |
| contract_id | bytes |
|
|
| token_contract_position | uint32 | the token contract position |
| Field | Type | Label | Description |
| token_id | bytes | 32‑byte token identifier |
|
| contract_info | GetTokenPerpetualDistributionLastClaimRequest.ContractTokenInfo | optional | This should be set if you wish to get back the last claim info as a specific type |
| identity_id | bytes | Identity whose last‑claim timestamp is requested |
|
| prove | bool | Return GroveDB / signature proof instead of raw value |
| Field | Type | Label | Description |
| v0 | GetTokenPerpetualDistributionLastClaimResponse.GetTokenPerpetualDistributionLastClaimResponseV0 |
|
| Field | Type | Label | Description |
| last_claim | GetTokenPerpetualDistributionLastClaimResponse.GetTokenPerpetualDistributionLastClaimResponseV0.LastClaimInfo | Direct answer |
|
| proof | Proof | GroveDB / quorum proof |
|
| metadata | ResponseMetadata | Chain context |
| Field | Type | Label | Description |
| timestamp_ms | uint64 | Unix epoch, ms |
|
| block_height | uint64 | Core‑block height |
|
| epoch | uint32 | Epoch index |
|
| raw_bytes | bytes | Arbitrary encoding |
| Field | Type | Label | Description |
| v0 | GetTokenPreProgrammedDistributionsRequest.GetTokenPreProgrammedDistributionsRequestV0 |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| start_at_info | GetTokenPreProgrammedDistributionsRequest.GetTokenPreProgrammedDistributionsRequestV0.StartAtInfo | optional |
|
| limit | uint32 | optional |
|
| prove | bool |
|
| Field | Type | Label | Description |
| start_time_ms | uint64 |
|
|
| start_recipient | bytes | optional |
|
| start_recipient_included | bool | optional |
|
| Field | Type | Label | Description |
| v0 | GetTokenPreProgrammedDistributionsResponse.GetTokenPreProgrammedDistributionsResponseV0 |
|
| Field | Type | Label | Description |
| token_distributions | GetTokenPreProgrammedDistributionsResponse.GetTokenPreProgrammedDistributionsResponseV0.TokenDistributions |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| recipient_id | bytes |
|
|
| amount | uint64 |
|
| Field | Type | Label | Description |
| token_distributions | GetTokenPreProgrammedDistributionsResponse.GetTokenPreProgrammedDistributionsResponseV0.TokenTimedDistributionEntry | repeated |
|
| Field | Type | Label | Description |
| timestamp | uint64 |
|
|
| distributions | GetTokenPreProgrammedDistributionsResponse.GetTokenPreProgrammedDistributionsResponseV0.TokenDistributionEntry | repeated |
|
| Field | Type | Label | Description |
| v0 | GetTokenStatusesRequest.GetTokenStatusesRequestV0 |
|
| Field | Type | Label | Description |
| token_ids | bytes | repeated |
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetTokenStatusesResponse.GetTokenStatusesResponseV0 |
|
| Field | Type | Label | Description |
| token_statuses | GetTokenStatusesResponse.GetTokenStatusesResponseV0.TokenStatuses |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| paused | bool | optional |
|
| Field | Type | Label | Description |
| token_statuses | GetTokenStatusesResponse.GetTokenStatusesResponseV0.TokenStatusEntry | repeated |
|
| Field | Type | Label | Description |
| v0 | GetTokenTotalSupplyRequest.GetTokenTotalSupplyRequestV0 |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetTokenTotalSupplyResponse.GetTokenTotalSupplyResponseV0 |
|
| Field | Type | Label | Description |
| token_total_supply | GetTokenTotalSupplyResponse.GetTokenTotalSupplyResponseV0.TokenTotalSupplyEntry |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| token_id | bytes |
|
|
| total_aggregated_amount_in_user_accounts | uint64 |
|
|
| total_system_amount | uint64 |
|
| Field | Type | Label | Description |
| v0 | GetTotalCreditsInPlatformRequest.GetTotalCreditsInPlatformRequestV0 |
|
| Field | Type | Label | Description |
| prove | bool |
|
| Field | Type | Label | Description |
| v0 | GetTotalCreditsInPlatformResponse.GetTotalCreditsInPlatformResponseV0 |
|
| Field | Type | Label | Description |
| credits | uint64 |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| v0 | GetVotePollsByEndDateRequest.GetVotePollsByEndDateRequestV0 |
|
| Field | Type | Label | Description |
| start_time_info | GetVotePollsByEndDateRequest.GetVotePollsByEndDateRequestV0.StartAtTimeInfo | optional |
|
| end_time_info | GetVotePollsByEndDateRequest.GetVotePollsByEndDateRequestV0.EndAtTimeInfo | optional |
|
| limit | uint32 | optional |
|
| offset | uint32 | optional |
|
| ascending | bool |
|
|
| prove | bool |
|
| Field | Type | Label | Description |
| end_time_ms | uint64 |
|
|
| end_time_included | bool |
|
| Field | Type | Label | Description |
| start_time_ms | uint64 |
|
|
| start_time_included | bool |
|
| Field | Type | Label | Description |
| v0 | GetVotePollsByEndDateResponse.GetVotePollsByEndDateResponseV0 |
|
| Field | Type | Label | Description |
| vote_polls_by_timestamps | GetVotePollsByEndDateResponse.GetVotePollsByEndDateResponseV0.SerializedVotePollsByTimestamps |
|
|
| proof | Proof |
|
|
| metadata | ResponseMetadata |
|
| Field | Type | Label | Description |
| timestamp | uint64 |
|
|
| serialized_vote_polls | bytes | repeated |
|
| Field | Type | Label | Description |
| vote_polls_by_timestamps | GetVotePollsByEndDateResponse.GetVotePollsByEndDateResponseV0.SerializedVotePollsByTimestamp | repeated |
|
| finished_results | bool |
|
| Field | Type | Label | Description |
| all_keys | AllKeys | Request for all keys |
|
| specific_keys | SpecificKeys | Request for specific keys by their IDs |
|
| search_key | SearchKey | Request for keys based on a search criteria |
| Field | Type | Label | Description |
| block_changes | BlockNullifierChanges | repeated |
|
Proof message includes cryptographic proofs for validating responses
| Field | Type | Label | Description |
| grovedb_proof | bytes | GroveDB proof for the data |
|
| quorum_hash | bytes | Hash of the quorum validating the data |
|
| signature | bytes | Signature proving data authenticity |
|
| round | uint32 | Consensus round number |
|
| block_id_hash | bytes | Hash of the block ID |
|
| quorum_type | uint32 | Type of the quorum |
ResponseMetadata provides metadata about the blockchain state at the time of
response
| Field | Type | Label | Description |
| height | uint64 | Current blockchain height |
|
| core_chain_locked_height | uint32 | Latest known core height in consensus |
|
| epoch | uint32 | Current epoch number |
|
| time_ms | uint64 | Timestamp in milliseconds |
|
| protocol_version | uint32 | Protocol version |
|
| chain_id | string | Identifier of the blockchain |
SearchKey represents a request to search for keys based on specific criteria
| Field | Type | Label | Description |
| purpose_map | SearchKey.PurposeMapEntry | repeated | Map of purposes to their security level maps |
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | SecurityLevelMap |
|
SecurityLevelMap maps security levels to a request type for key retrieval
| Field | Type | Label | Description |
| security_level_map | SecurityLevelMap.SecurityLevelMapEntry | repeated | Maps security levels to key request types |
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | SecurityLevelMap.KeyKindRequestType |
|
SpecificKeys is used to request specific keys by their IDs
| Field | Type | Label | Description |
| key_ids | uint32 | repeated | List of key IDs |
| Field | Type | Label | Description |
| code | uint32 |
|
|
| message | string |
|
|
| data | bytes |
|
| Field | Type | Label | Description |
| v0 | WaitForStateTransitionResultRequest.WaitForStateTransitionResultRequestV0 |
|
| Field | Type | Label | Description |
| state_transition_hash | bytes | The hash of the state transition to wait for |
|
| prove | bool | Flag to request a proof as the response |
| Field | Type | Label | Description |
| v0 | WaitForStateTransitionResultResponse.WaitForStateTransitionResultResponseV0 |
|
| Field | Type | Label | Description |
| error | StateTransitionBroadcastError | Any error that occurred during the state transition broadcast |
|
| proof | Proof | Cryptographic proof for the state transition, if requested |
|
| metadata | ResponseMetadata | Metadata about the blockchain state |
| Name | Number | Description |
| TOWARDS_IDENTITY | 0 | |
| ABSTAIN | 1 | |
| LOCK | 2 |
| Name | Number | Description |
| DOCUMENTS | 0 | |
| VOTE_TALLY | 1 | |
| DOCUMENTS_AND_VOTE_TALLY | 2 |
| Name | Number | Description |
| TOWARDS_IDENTITY | 0 | |
| LOCKED | 1 | |
| NO_PREVIOUS_WINNER | 2 |
| Name | Number | Description |
| ACTIVE | 0 | Request the active actions |
| CLOSED | 1 | Request the closed actions |
| Name | Number | Description |
| ACTIVE | 0 | Request the active actions |
| CLOSED | 1 | Request the closed actions |
Enum for emergency action types
| Name | Number | Description |
| PAUSE | 0 | Pause action |
| RESUME | 1 | Resume action |
| Name | Number | Description |
| AUTHENTICATION | 0 | |
| ENCRYPTION | 1 | |
| DECRYPTION | 2 | |
| TRANSFER | 3 | |
| VOTING | 5 |
| Name | Number | Description |
| CURRENT_KEY_OF_KIND_REQUEST | 0 | Request the current key of a particular kind |
| ALL_KEYS_OF_KIND_REQUEST | 1 | Request all keys of a particular kind |
| Field | Type | Label | Description |
| headers | bytes | repeated |
|
| Field | Type | Label | Description |
| from_block_hash | bytes |
|
|
| from_block_height | uint32 |
|
|
| count | uint32 |
|
| Field | Type | Label | Description |
| block_headers | BlockHeaders |
|
|
| chain_lock | bytes |
|
| Field | Type | Label | Description |
| v_data | bytes |
|
|
| n_hash_funcs | uint32 |
|
|
| n_tweak | uint32 |
|
|
| n_flags | uint32 |
|
| Field | Type | Label | Description |
| transaction | bytes |
|
|
| allow_high_fees | bool |
|
|
| bypass_limits | bool |
|
| Field | Type | Label | Description |
| transaction_id | string |
|
| Field | Type | Label | Description |
| height | uint32 |
|
| Field | Type | Label | Description |
| height | uint32 |
|
|
| hash | string |
|
| Field | Type | Label | Description |
| block | bytes |
|
| Field | Type | Label | Description |
| version | GetBlockchainStatusResponse.Version |
|
|
| time | GetBlockchainStatusResponse.Time |
|
|
| status | GetBlockchainStatusResponse.Status |
|
|
| sync_progress | double |
|
|
| chain | GetBlockchainStatusResponse.Chain |
|
|
| network | GetBlockchainStatusResponse.Network |
|
| Field | Type | Label | Description |
| name | string |
|
|
| headers_count | uint32 |
|
|
| blocks_count | uint32 |
|
|
| best_block_hash | bytes |
|
|
| difficulty | double |
|
|
| chain_work | bytes |
|
|
| is_synced | bool |
|
|
| sync_progress | double |
|
| Field | Type | Label | Description |
| peers_count | uint32 |
|
|
| fee | GetBlockchainStatusResponse.NetworkFee |
|
| Field | Type | Label | Description |
| relay | double |
|
|
| incremental | double |
|
| Field | Type | Label | Description |
| now | uint32 |
|
|
| offset | int32 |
|
|
| median | uint32 |
|
| Field | Type | Label | Description |
| protocol | uint32 |
|
|
| software | uint32 |
|
|
| agent | string |
|
| Field | Type | Label | Description |
| blocks | uint32 |
|
| Field | Type | Label | Description |
| fee | double |
|
| Field | Type | Label | Description |
| status | GetMasternodeStatusResponse.Status |
|
|
| pro_tx_hash | bytes |
|
|
| pose_penalty | uint32 |
|
|
| is_synced | bool |
|
|
| sync_progress | double |
|
| Field | Type | Label | Description |
| id | string |
|
| Field | Type | Label | Description |
| transaction | bytes |
|
|
| block_hash | bytes |
|
|
| height | uint32 |
|
|
| confirmations | uint32 |
|
|
| is_instant_locked | bool |
|
|
| is_chain_locked | bool |
|
| Field | Type | Label | Description |
| messages | bytes | repeated |
|
| Field | Type | Label | Description |
| masternode_list_diff | bytes |
|
| Field | Type | Label | Description |
| transactions | bytes | repeated |
|
| Field | Type | Label | Description |
| bloom_filter | BloomFilter |
|
|
| from_block_hash | bytes |
|
|
| from_block_height | uint32 |
|
|
| count | uint32 |
|
|
| send_transaction_hashes | bool |
|
| Field | Type | Label | Description |
| raw_transactions | RawTransactions |
|
|
| instant_send_lock_messages | InstantSendLockMessages |
|
|
| raw_merkle_block | bytes |
|
| Name | Number | Description |
| NOT_STARTED | 0 | |
| SYNCING | 1 | |
| READY | 2 | |
| ERROR | 3 |
| Name | Number | Description |
| UNKNOWN | 0 | |
| WAITING_FOR_PROTX | 1 | |
| POSE_BANNED | 2 | |
| REMOVED | 3 | |
| OPERATOR_KEY_CHANGED | 4 | |
| PROTX_IP_CHANGED | 5 | |
| READY | 6 | |
| ERROR | 7 |
| Method Name | Request Type | Response Type | Description |
| getBlockchainStatus | GetBlockchainStatusRequest | GetBlockchainStatusResponse | |
| getMasternodeStatus | GetMasternodeStatusRequest | GetMasternodeStatusResponse | |
| getBlock | GetBlockRequest | GetBlockResponse | |
| getBestBlockHeight | GetBestBlockHeightRequest | GetBestBlockHeightResponse | |
| broadcastTransaction | BroadcastTransactionRequest | BroadcastTransactionResponse | |
| getTransaction | GetTransactionRequest | GetTransactionResponse | |
| getEstimatedTransactionFee | GetEstimatedTransactionFeeRequest | GetEstimatedTransactionFeeResponse | |
| subscribeToBlockHeadersWithChainLocks | BlockHeadersWithChainLocksRequest | BlockHeadersWithChainLocksResponse stream | |
| subscribeToTransactionsWithProofs | TransactionsWithProofsRequest | TransactionsWithProofsResponse stream | |
| subscribeToMasternodeList | MasternodeListRequest | MasternodeListResponse stream |
| Field | Type | Label | Description |
| state_transition | bytes |
|
| Field | Type | Label | Description |
| proof | org.dash.platform.dapi.v0.Proof | Cryptographic proof for the requested data |
|
| metadata | org.dash.platform.dapi.v0.ResponseMetadata | Metadata about the blockchain state |
| Method Name | Request Type | Response Type | Description |
| getProofs | GetProofsRequest | GetProofsResponse |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |