Module generated Copy item path Source account_credential Nested message and enum types in AccountCredential. account_identifier_input Nested message and enum types in AccountIdentifierInput. account_info Nested message and enum types in AccountInfo. account_staking_info Nested message and enum types in AccountStakingInfo. account_transaction_effects Nested message and enum types in AccountTransactionEffects. account_transaction_payload Nested message and enum types in AccountTransactionPayload. account_verify_key Nested message and enum types in AccountVerifyKey. address Nested message and enum types in Address. ar_info Nested message and enum types in ArInfo. baker_event Nested message and enum types in BakerEvent. block_finalization_summary Nested message and enum types in BlockFinalizationSummary. block_hash_input Nested message and enum types in BlockHashInput. block_item Nested message and enum types in BlockItem. block_item_status Nested message and enum types in BlockItemStatus. block_item_summary Nested message and enum types in BlockItemSummary. block_special_event Nested message and enum types in BlockSpecialEvent. blocks_at_height_request Nested message and enum types in BlocksAtHeightRequest. chain_parameters Nested message and enum types in ChainParameters. contract_trace_element Nested message and enum types in ContractTraceElement. cooldown Nested message and enum types in Cooldown. credential_deployment Nested message and enum types in CredentialDeployment. delegation_event Nested message and enum types in DelegationEvent. delegation_target Nested message and enum types in DelegationTarget. dry_run_error_response Nested message and enum types in DryRunErrorResponse. dry_run_request Nested message and enum types in DryRunRequest. dry_run_response Nested message and enum types in DryRunResponse. dry_run_state_operation Nested message and enum types in DryRunStateOperation. dry_run_state_query Nested message and enum types in DryRunStateQuery. dry_run_success_response Nested message and enum types in DryRunSuccessResponse. election_info Nested message and enum types in ElectionInfo. epoch_request Nested message and enum types in EpochRequest. instance_info Nested message and enum types in InstanceInfo. invoke_instance_response Nested message and enum types in InvokeInstanceResponse. ip_info Nested message and enum types in IpInfo. level1_update Nested message and enum types in Level1Update. node_info Nested message and enum types in NodeInfo. peers_info Nested message and enum types in PeersInfo. pending_update Nested message and enum types in PendingUpdate. plt pool_pending_change Nested message and enum types in PoolPendingChange. queries_client Generated client implementations. reject_reason Nested message and enum types in RejectReason. root_update Nested message and enum types in RootUpdate. send_block_item_request Nested message and enum types in SendBlockItemRequest. stake_pending_change Nested message and enum types in StakePendingChange. tokenomics_info Nested message and enum types in TokenomicsInfo. update_instruction_payload Nested message and enum types in UpdateInstructionPayload. update_payload Nested message and enum types in UpdatePayload. versioned_module_source Nested message and enum types in VersionedModuleSource. AbsoluteBlockHeight The absolute height of a block. This is the number of ancestors of a block
since the genesis block. In particular, the chain genesis block has absolute
height 0. AccessStructure An access structure which specifies which UpdatePublicKeys in a HigherLevelKeys that are allowed
to make chain update of a specific type. The threshold defines the minimum number of allowed keys needed
to make the actual update. AccountAddress An address of an account. Always 32 bytes. AccountCreationDetails Details of an account creation. These transactions are free, and we only
ever get a response for them if the account is created, hence no failure
cases. AccountCredential Credential that is part of an account. AccountIdentifierInput Input to queries which take an account as a parameter. AccountIndex Index of the account in the account table. These are assigned sequentially
in the order of creation of accounts. The first account has index 0. AccountInfo Information about the account at a particular point in time. AccountInfoRequest Request for account information. AccountPending Indicates that an account is pending – either a scheduled release or a cooldown – and
when the first release or cooldown will elapse. AccountSignatureMap Wrapper for a map from indexes to signatures.
Needed because protobuf doesn’t allow nested maps directly.
The keys in the SignatureMap must not exceed 2^8. AccountStakingInfo Information about the account stake, if the account is either a baker or a
delegator. AccountThreshold The number of credentials required to sign an account transaction. AccountTransaction Account transactions are messages which are signed and paid for by the sender
account. AccountTransactionDetails Details about an account transaction. AccountTransactionEffects Effects of an account transaction. All variants except None
correspond to a unique transaction that was successful. AccountTransactionHeader Header of an account transaction that contains basic data to check whether
the sender and the transaction are valid. The header is shared by all transaction types. AccountTransactionPayload The payload for an account transaction. AccountTransactionSignHash Signature on an account transaction is defined to be the signature on the
hash of the PreAccountTransaction. AccountTransactionSignature AccountVerifyKey A public key used to verify transaction signatures from an account. Address An address of either a contract or an account. AggregatedSignatures Amount An amount of microCCD. AmountFraction A fraction of an amount with a precision of 1/100_000. AncestorsRequest Request the ancestors for the given block. ArInfo Information on a single anonymity revoker help by the identity provider.
Typically an identity provider will hold more than one. ArThreshold The number of anonymity revokers needed to revoke anonymity of a credential
holder. ArrivedBlockInfo Information about an arrived block that is part of the streaming response. AuthorizationsV0 The set of keys authorized for chain updates, together with access structures
determining which keys are authorized for which update types.
This is the payload of an update to authorization. AuthorizationsV1 The set of keys authorized for chain updates, together with access structures
determining which keys are authorized for which update types.
This is the payload of an update to authorization. BakerAggregationVerifyKey Baker’s public key used to check signatures on finalization records.
This is only used if the baker has sufficient stake to participate in
finalization. BakerElectionVerifyKey Baker’s public key used to check whether they won the lottery or not. BakerEvent Events that may result from the ConfigureBaker transaction. BakerId The ID of a baker, which is the index of its account. BakerInfo Information about a baker. BakerKeysEvent Result of a successful change of baker keys. BakerPoolInfo Additional information about a baking pool.
This information is added with the introduction of delegation. BakerRewardPeriodInfo Information about a particular baker with respect to
the current reward period. BakerSignatureVerifyKey Baker’s public key used to check that they are indeed the ones who
produced the block. BakerStakeThreshold Minimum stake needed to become a baker. This only applies to protocol version
1-3. BakerStakeUpdatedData BakersAndFinalizers BannedPeer A banned peer BannedPeers The banned peers given by
their IP addresses. BlockCertificates Certificates for a block for protocols supporting
ConcordiumBFT. BlockFinalizationSummary Finalization summary that may or may not be part of the block. BlockHash Hash of a block. This is always 32 bytes long. BlockHashInput Input to queries which take a block as a parameter. BlockHeight The height of a block relative to the last genesis. This differs from the
absolute block height in that it counts height from the last protocol update. BlockInfo The response for GetBlockInfo. BlockItem BlockItemStatus Status of a block item known to the node. BlockItemSummary Summary of the outcome of a block item in structured form.
The summary determines which transaction type it was. BlockItemSummaryInBlock A block item summary together with a block hash. Used in BlockItemStatus. BlockSignature A (non-aggregate) signature of a validator. This is used to sign blocks produced by
the validator as well as some finalization messages. BlockSpecialEvent A protocol generated event that is not directly caused by a transaction. This
includes minting new CCD, rewarding different bakers and delegators, etc. BlockTableSummary BlocksAtHeightRequest Request for GetBlocksAtHeight. BlocksAtHeightResponse Response for GetBlocksAtHeight. Branch Response type for GetBranches. BranchBlocks A list of block hashes at a particular branch height. CapitalBound A bound on the relative share of the total staked capital that a baker can
have as its stake. This is required to be greater than 0. ChainArData Data relating to a single anonymity revoker sent by the account holder to
the chain. ChainParameters Chain parameters. ChainParametersV0 Updatable chain parameters that apply to protocol versions 1-3. ChainParametersV1 Updatable chain parameters that apply to protocol versions 4-5. ChainParametersV2 Updatable chain parameters that apply to protocol versions 6. ChainParametersV3 Updatable chain parameters that apply to protocol versions 8. CommissionRanges Ranges of allowed commission values that pools may choose from. CommissionRates Distribution of the rewards for the particular pool. Commitment A single commitment in the G1 group of the BLS curve. This is always 48 bytes
in length. ConsensusDetailedStatus ConsensusDetailedStatusQuery ConsensusInfo The response for GetConsensusInfo. ConsensusParametersV1 Parameters for the consensus protocol used from protocol version 6. ContractAddress Address of a smart contract instance. ContractEvent An event generated by a smart contract. ContractInitializedEvent Data generated as part of initializing a single contract instance. ContractStateV0 A smart contract v0 state. ContractTraceElement Effects produced by successful smart contract invocations.
A single invocation will produce a sequence of these effects. Cooldown CooldownParametersCpv1 CredentialCommitments Commitments that are part of a normal credential. CredentialDeployment Credential deployments create new accounts. They are not paid for
directly by the sender. Instead, bakers are rewarded by the protocol for
including them. CredentialIndex Index of a credential on an account. CredentialPublicKeys Public keys of a single credential. CredentialRegistrationId A registration ID of a credential, derived from the secret PRF key and a
nonce. This is always 48 bytes long. CredentialsPerBlockLimit The number of credential deployments allowed in a block. This in effect
determines the number of accounts that can be created in a block. CryptographicParameters The response for GetCryptographicParameters. DelegationEvent DelegationTarget Entity to which the account delegates a portion of its stake. DelegatorId The identifier for a delegator. DelegatorInfo Stream item for GetPoolDelegators and GetPassiveDelegators. DelegatorRewardPeriodInfo Stream item for GetPoolDelegatorsRewardPeriod and GetPassiveDelegatorsRewardPeriod. Description Description either of an anonymity revoker or identity provider.
Metadata that should be visible on the chain. DryRunErrorResponse DryRunInvokeInstance Invoke an entrypoint on a smart contract instance. DryRunMintToAccount Mint a specified amount and credit it to the specified account as part of a dry run. DryRunRequest An operation to dry run. The first operation in a dry-run sequence should be
load_block_state: any other operation will be met with NoState until a
state is successfully loaded. DryRunResponse A response to a DryRunRequest. DryRunSignature A dry run signature is a pair of a credential index and key index, identifying the credential
and key that is presumed to have signed the transaction. No actual cryptographic signature is
included. DryRunStateOperation An operation that can update the state as part of a dry run. DryRunStateQuery Run a query as part of a dry run. Queries do not update the block state. DryRunSuccessResponse The dry run operation completed successfully. DryRunTransaction Dry run an account transaction DumpRequest Request to enable dumping of network packages. Duration A duration of milliseconds. DurationSeconds A duration in seconds. ElectionDifficulty Election difficulty parameter. ElectionInfo Response type for GetElectionInfo.
Contains information related to baker election for a perticular block. Empty A message that contains no information. EncryptedAmount An encrypted amount, in two chunks in “little endian limbs”. That is, the
first chunk represents the low 32 bits of an amount, and the second chunk
represents the high 32 bits. The chunks are serialized in order and
represented as a byte array.
Always 192 bytes. EncryptedAmountRemovedEvent Event generated when one or more encrypted amounts are consumed from the account. EncryptedBalance EncryptedSelfAmountAddedEvent EncryptionKey An account encryption key. Always 96 bytes. Energy Energy is used to count exact execution cost.
This cost is then converted to CCD amounts. Epoch A chain epoch. EpochBakers EpochFinalizationEntry The epoch finalization entry is the proof that
makes the protocol able to advance to a new epoch.
I.e. the ‘EpochFinalizationEntry’ is present if and only if
the block is the first block of a new ‘Epoch’. EpochRequest Input to queries which take an epoch as a parameter. ExchangeRate Represents an exchange rate. FinalizationCommitteeHash The hash of the finalization committee, derived from the weights and aggregation
keys of the finalizers. FinalizationCommitteeParameters Finalization committee parameters used from protocol version 6 FinalizationIndex Index of the finalization round. This increases on each successfully
completed finalization. FinalizationSummary Details about a finalization record included in a block. FinalizationSummaryParty Details about a finalizer for the finalization round. FinalizedBlockInfo Information about a finalized block that is part of the streaming response. FinalizerIndex The index of a particular finalizer in the finalization committee. FinalizerRound The finalizer round is a map from a ‘Round’
to the list of finalizers (identified by their ‘BakerId’) that signed
off the round. FullBakerInfo The keys an stake of a specific baker. GasRewards Distribution of gas rewards for chain parameters version 0 and 1. GasRewardsCpv2 Distribution of gas rewards for chain parameters version 2. GenesisIndex The number of chain restarts via a protocol update. An effected
protocol update instruction might not change the protocol version
specified in the previous field, but it always increments the genesis
index. GetPoolDelegatorsRequest Request for GetPoolDelegators and GetPoolDelegatorsRewardPeriod. HigherLevelKeys Represents root or level 1 keys. IdentityProviderIdentity An index of the identity provider that identifies them uniquely in the
context of a specific chain. InclusiveRangeAmountFraction Inclusive range of amount fractions. InitContractPayload Data required to initialize a new contract instance. InitName The init name of a smart contract function. Expected format:
init_<contract_name>. It must only consist of atmost 100 ASCII alphanumeric
or punctuation characters, must not contain a ‘.’ and must start with
‘init_’. InitialCredentialValues Values contained in an initial credential. InstanceInfo Information about a smart contract instance. InstanceInfoRequest Request for getting information about a smart contract instance. InstanceStateKvPair A smart contract instance key-value pair. InstanceStateLookupRequest Request for a specific key of a smart contract instance state. InstanceStateValueAtKey Value at the requested key of a smart contract instance state. For V0
contracts this will always be the entire state of the contract. InstanceUpdatedEvent Data generated as part of updating a single contract instance.
In general a single Update transaction will
generate one or more of these events, together with possibly some transfers. InvokeInstanceRequest Request for InvokeInstance. InvokeInstanceResponse Response type for InvokeInstance. IpAddress A request to send a new block item to the chain.
An IP address IpIdentity A succinct identifier of an identity provider on the chain.
In credential deployments, and other interactions with the chain this is
used to identify which identity provider is meant. IpInfo Public information about an identity provider. IpSocketAddress A socket address consisting of
an IP + port. LeadershipElectionNonce The leadership election nonce is an unpredictable value updated once an
epoch to make sure that bakers cannot predict too far in the future when
they will win the right to bake blocks. Level1Update Level 1 updates are the intermediate update kind.
They can update themselves or level 2 keys. They can only be performed by level 1 keys. LeverageFactor A leverage factor. Memo A memo which can be included as part of a transfer. Max size is 256 bytes. MintDistributionCpv0 The minting rate and the distribution of newly-minted CCD among bakers,
finalizers, and the foundation account. It must be the case that
baking_reward + finalization_reward <= 1. The remaining amount is the
platform development charge. MintDistributionCpv1 Mint distribution payload as it looks in protocol version 4 and onward. MintRate A minting rate of CCD.
The value is mantissa * 10^(-exponent). ModuleRef A smart contract module reference. This is always 32 bytes long. ModuleSourceRequest Request for getting the source of a smart contract module. NewEncryptedAmountEvent Event generated when an account receives a new encrypted amount. NewRelease A new individual release. Part of a single transfer with schedule transaction. NextAccountSequenceNumber The response for getNextAccountSequenceNumber. NextUpdateSequenceNumbers The response for GetNextUpdateSequenceNumbers. NodeInfo Node info response
Contains various information of the
enquired node. NormalCredentialValues Values contained in a normal (non-initial) credential. Parameter Parameter to a smart contract initialization or invocation. PassiveDelegationInfo Type for the response of GetPassiveDelegationInfo.
Contains information about passive delegators at the end of a given block. PeerId A peer id
An identifier that the peer wants to be
be recoknized by.
The underlying value is simply a u64.
Note. There is no authenticity of the peer id and
as such it is only used for logging purposes. PeerToBan A peer to ban specified by its IP.
Note. This will ban all peers located behind the
specified IP even though they are using different ports. PeersInfo Peers and their associated network related statistics PendingUpdate A pending update. PersistentRoundStatus Policy Policy on a credential. PoolCurrentPaydayInfo Information about a baker pool in the current reward period. PoolInfoRequest Request for GetPoolInfo. PoolInfoResponse Type for the response of GetPoolInfo.
Contains information about a given pool at the end of a given block.
From protocol version 7, pool removal has immediate effect, however, the
pool may still be present for the current (and possibly next) reward period.
In this case, the current_payday_info field will be set, but the
equity_capital, delegated_capital, delegated_capital_cap and,
pool_info fields will all be absent. The equity_pending_change field
will also be absent, as stake changes are immediate. PoolParametersCpv1 Parameters related to staking pools. PoolPendingChange A pending change to a baker pool. Port A port
Valid port numbers are expected thus
the value is expected to be in the range (0..u16::MAX). PreAccountTransaction An unsigned account transaction. This is used with the
GetTransactionSignHash endpoint to obtain the message to sign. ProtocolUpdate QuorumCertificate A quorum certificate is the certificate that the
finalization comittee issues in order to certify a block.
A block must be certified before it will be part of the
authorative part of the chain. QuorumMessage The message that is multicast by a finalizer when validating and signing a block. QuorumMessages QuorumSignature The signature of a ‘QuorumCertificate’ or ‘QuorumMessage’. Ratio Represents a ratio, i.e., ‘numerator / denominator’. RawFinalizationEntry RawFinalizerRound RawQuorumCertificate RawTimeoutCertificate A timeout certificate is the certificate that the
finalization committee issues when a round times out,
thus making it possible for the protocol to proceed to the
next round. ReceiveName The receive name of a smart contract function. Expected format:
<contract_name>.<func_name>. It must only consist of atmost 100 ASCII
alphanumeric or punctuation characters, and must contain a ‘.’. RegisteredData Data registered on the chain with a register data transaction. RejectReason A reason for why a transaction was rejected. Rejected means included in a
block, but the desired action was not achieved. The only effect of a
rejected transaction is payment. Release An individual release of a locked balance. ReleaseSchedule State of the account’s release schedule. This is the balance of the account
that is owned by the account, but cannot be used until the release point. RewardPeriodLength Length of a reward period in epochs.
Must always be a strictly positive number. RootUpdate Root updates are the highest kind of key updates. They can update every other set of keys,
even themselves. They can only be performed by Root level keys. Round A round. RoundExistingBlock RoundExistingQc RoundStatus The current round status. RoundTimeout SendBlockItemRequest SequenceNumber A sequence number that determines the ordering of transactions from the
account. The minimum sequence number is 1. Sha256Hash A SHA256 hash. This is always 32 bytes long. Signature A single signature. Used when sending block items to a node with
SendBlockItem. SignatureMap A signature on an update instruction.
The type UpdateKeysIndex is not used directly, as messages cannot be keys in maps. SignatureThreshold The number of signatures required to sign. Slot A number representing a slot for baking a block. StakePendingChange Pending change to the stake either of a baker or delegator. StateHash Hash of the state after some block. This is always 32 bytes long. SuccessorProof A proof that establishes that the successor block of
a ‘EpochFinalizationEntry’ is the immediate successor of
the finalized block. TimeParametersCpv1 The time parameters are introduced as of protocol version 4, and consist of
the reward period length and the mint rate per payday. These are coupled as
a change to either affects the overall rate of minting. TimeoutCertificate A timeout certificate is the certificate that the
finalization committee issues when a round times out,
thus making it possible for the protocol to proceed to the
next round. TimeoutMessage A timeout message including the sender’s signature. TimeoutMessages TimeoutParameters Parameters that determine timeouts in the consensus protocol used from protocol version 6. TimeoutSignature The signature of a ‘TimeoutCertificate’. Timestamp Unix timestamp in milliseconds. TokenInfo The token state at the block level. TokenInfoRequest Request for token information. TokenomicsInfo Type for the response of GetTokenomicsInfo.
Contains information related to tokenomics at the end of a given block. TransactionFeeDistribution Parameters determining the distribution of transaction fees. TransactionHash Hash of a transaction. This is always 32 bytes long. TransactionTime Transaction time specified as seconds since unix epoch. TransferPayload Payload of a transfer between two accounts. TransferWithMemoPayload Payload of a transfer between two accounts with a memo. UpdateContractPayload Data required to update a contract instance. UpdateDetails Details of an successful update instruction. These are free, and we only ever get a
response for them if the update is successfully enqueued, hence no failure
cases. UpdateInstruction UpdateInstructionHeader UpdateInstructionPayload The payload for an UpdateInstruction. UpdateKeysIndex Index of a key in an authorizations update payload. UpdateKeysThreshold The threshold for how many UpdatePublicKeys are need to make a certain chain update. UpdatePayload The payload of a chain update. UpdatePublicKey A public key used for chain updates. UpdateSequenceNumber A sequence number that determines the ordering of update transactions.
Equivalent to SequenceNumber for account transactions.
Update sequence numbers are per update type and the minimum value is 1. ValidatorScoreParameters VersionedModuleSource Source bytes of a versioned smart contract module. WinningBaker Details of which baker won the lottery in a given round in consensus version 1. YearMonth Representation of the pair of a year and month. ContractVersion Version of smart contract. CredentialType The type of a credential. OpenStatus Information about how open the pool is to new delegators. ProtocolVersion The different versions of the protocol. TransactionType The type of transaction. UpdateType The type of chain update.