Skip to content

GRPC

Classes:

Name Description
CCD_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.

CCD_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.

CCD_AccountCredential

Credential that is part of an account.

CCD_AccountInfo

Information about the account at a particular point in time.

CCD_AccountPending

Information about a pending account.

CCD_AccountStakingInfo

Information about the account stake, if the account is either a validator or a delegator.

CCD_AccountStakingInfo_Baker

Information about an account that is registered as a validator.

CCD_AccountStakingInfo_Delegator

Information about an account that has delegated its stake to a pool.

CCD_AccountTransactionDetails

Details about an account transaction.

CCD_AccountTransactionEffects

Effects of an account transaction. All variants except None correspond to a unique transaction that was successful.

CCD_AccountTransactionEffects_CredentialsUpdated

Event generated when account credentials are updated.

CCD_AccountTransactionEffects_EncryptedAmountTransferred

Event generated when transferring an encrypted amount.

CCD_AccountTransactionEffects_None

No effects other than payment from this transaction.

CCD_AccountTransactionEffects_TransferredToPublic

Event generated when an amount is transferred from encrypted to public balance.

CCD_AccountTransfer

A simple transfer of CCD tokens from one account to another.

CCD_AccountVerifyKey

A public key used to verify transaction signatures from an account.

CCD_Address

An address of either a contract or an account.

CCD_AggregatedSignatures

Aggregated signatures from a set of finalizers.

CCD_ArInfo

Information on a single anonymity revoker help by the identity provider. Typically an identity provider will hold more than one.

CCD_ArrivedBlockInfo

Information about an arrived block that is part of the streaming response.

CCD_AuthorizationsV0

The set of keys authorized for chain updates, together with access structures determining which keys are authorized for which update types.

CCD_AuthorizationsV1

The set of keys authorized for chain updates, together with access structures determining which keys are authorized for which update types. Similar to AuthorizationsV0 except that a few more keys can be updated.

CCD_BakerAdded

Data generated when a new validator is added.

CCD_BakerConfigured

A validator was configured. The details of what happened are contained in the list of BakerEvents.

CCD_BakerEvent

Events that may result from the ConfigureBaker transaction.

CCD_BakerEvent_BakerRestakeEarningsUpdated

A validator's setting for restaking earnings was updated.

CCD_BakerInfo

Information about a validator.

CCD_BakerKeysEvent

Event containing all keys of a validator, including aggregation key.

CCD_BakerPoolInfo

Additional information about a validator pool.

CCD_BakerRestakeEarningsUpdated

A validator's setting for restaking earnings was updated.

CCD_BakerResumed

Data generated when a baker is resumed after being suspended.

CCD_BakerSetBakingRewardCommission

Updated baking reward commission for validator pool.

CCD_BakerSetFinalizationRewardCommission

Updated finalization reward commission for validator pool.

CCD_BakerSetMetadataUrl

Updated metadata url for a validator pool.

CCD_BakerSetOpenStatus

Updated open status for a validator pool.

CCD_BakerSetTransactionFeeCommission

Updated transaction fee commission for a validator pool.

CCD_BakerStakeDecreased

Validator stake decreased.

CCD_BakerStakeIncreased

Validator stake increased.

CCD_BakerStakePendingChange

A pending change to a validator's staking. Either a reduction in stake amount, or complete removal of stake.

CCD_BakerStakePendingChange_Reduce

The validator's equity capital will be reduced at the specified time.

CCD_BakerStakePendingChange_Remove

The validator's stake will be removed at the specified time.

CCD_BakerStakeThreshold

Minimum stake needed to become a validator. This only applies to protocol version 1-3.

CCD_BakerStakeUpdated

An account was deregistered as a validator. This is the result of a successful UpdateBakerStake transaction.

CCD_BakerStakeUpdatedData

Validator stake updated data.

CCD_BakersAndFinalizers

The set of bakers and finalizers in a particular consensus epoch.

CCD_Block

CCD_Block represents the txs from a block (custom class)

CCD_BlockComplete

CCD_BlockComplete represents a complete block, including block_info, transaction_summaries and special_events, as well as logged_events.

CCD_BlockInfo

Information about a block.

CCD_BlockItemSummary

Summary of the outcome of a block item in structured form. The summary determines which transaction type it was.

CCD_BlockSpecialEvent

A protocol generated event that is not directly caused by a transaction. This includes minting new CCD, rewarding different bakers and delegators, etc.

CCD_BlockSpecialEvent_AccountAmounts

A representation of a mapping from an account address to an amount.

CCD_BlockSpecialEvent_AccountAmounts_Entry

Entry for mapping from an account address to an amount.

CCD_BlockSpecialEvent_BakingRewards

Payment to each validator of a previous epoch, in proportion to the number of blocks they contributed.

CCD_BlockSpecialEvent_BlockAccrueReward

Amounts accrued to accounts for each baked block.

CCD_BlockSpecialEvent_BlockReward

Disbursement of fees from a block between the GAS account, the validator, and the foundation. It should always be that:

CCD_BlockSpecialEvent_FinalizationRewards

Payment to each finalizer on inclusion of a finalization record in a block.

CCD_BlockSpecialEvent_Mint

Minting of new CCD.

CCD_BlockSpecialEvent_PaydayAccountReward

Reward payment to the given account.

CCD_BlockSpecialEvent_PaydayFoundationReward

Foundation tax.

CCD_BlockSpecialEvent_PaydayPoolReward

Payment distributed to a pool or passive delegators.

CCD_BlockSpecialEvent_ValidatorPrimedForSuspension

The id of a validator that is primed for suspension at the next snapshot epoch due to too many missed rounds.

CCD_BlockSpecialEvent_ValidatorSuspended

The id of a validator that got suspended due to too many missed rounds.

CCD_BlockTableSummary

Summary information about the block table in the node.

CCD_BlocksAtHeightResponse

Response for GetBlocksAtHeight containing the live blocks at a given height.

CCD_BranchBlocks

A list of blocks at a specific branch height.

CCD_CapitalBound

A bound on the relative share of the total staked capital that a validator can have as its stake. This is required to be greater than 0.

CCD_ChainArData

Data relating to a single anonymity revoker sent by the account holder to the chain.

CCD_ChainParameters

Contains the chain parameters for a particular version of the protocol.

CCD_ChainParametersV0

Chain parameters that apply in protocol versions 1-3.

CCD_ChainParametersV1

Chain parameters that apply from protocol version 4 onwards.

CCD_ChainParametersV2

Chain parameters that apply from protocol version 6 onwards.

CCD_ChainParametersV3

Chain parameters that apply from protocol version 8 onwards.

CCD_CommissionRanges

Ranges of allowed commission values that pools may choose from.

CCD_CommissionRates

Distribution of rewards for a particular pool.

CCD_ConsensusDetailedStatus

Detailed status of consensus at a particular point in time.

CCD_ConsensusDetailedStatusQuery

Query for detailed consensus status at a specific genesis index.

CCD_ConsensusInfo

Contains the consensus information in a node.

CCD_ConsensusParametersV1

Parameters controlling consensus from protocol version 6 onwards.

CCD_ContractAddress

Address of a smart contract instance.

CCD_ContractInitializedEvent

Data generated as part of initializing a single contract instance.

CCD_ContractTraceElement

A trace element for a contract execution. Recording what happened during the execution.

CCD_ContractTraceElement_Interrupted

A contract was interrupted. This occurs when a contract invokes another contract or makes a transfer to an account.

CCD_ContractTraceElement_Resumed

A previously interrupted contract was resumed.

CCD_ContractTraceElement_Transferred

A contract transferred an amount to an account.

CCD_ContractTraceElement_Upgraded

A contract was upgraded from one module to another.

CCD_ContractUpdateIssued

The effects of executing a smart contract update transaction.

CCD_Cooldown

The stake on the account that is in cooldown. When stake is removed from a validator or delegator (from protocol version 7) it first enters the pre-pre-cooldown state. The next time the stake snapshot is taken (at the epoch transition before a payday) it enters the pre-cooldown state. At the subsequent payday, it enters the cooldown state. At the payday after the end of the cooldown period, the stake is finally released.

CCD_CooldownParametersCpv1

Parameters related to cooldown periods for pool owners and delegators.

CCD_CredentialCommitments

Commitments that are part of a normal credential.

CCD_CredentialCommitments_AttributesEntry

A map entry in CredentialCommitments.attributes, containing commitments to attributes which have not been revealed in the policy.

CCD_CredentialPublicKeys

Public keys of a single credential.

CCD_CredentialType

The type of credential. Initial credentials have a special status, while normal credentials are subject to additional verification.

CCD_CurrentPaydayStatus

Information about a validator's stake, rewards and status for the current reward period.

CCD_DelegationConfigured

An account configured delegation. The details of what happened are contained in the list of DelegationEvents.

CCD_DelegationEvent

Events that may result from configuring delegation.

CCD_DelegationSetDelegationTarget

The delegator's delegation target was updated.

CCD_DelegationSetRestakeEarnings

The delegator's restaking setting was updated.

CCD_DelegationStakeDecreased

The delegator's stake decreased.

CCD_DelegationStakeIncreased

The delegator's stake increased.

CCD_DelegationTarget

Entity to which the account delegates a portion of its stake.

CCD_DelegatorInfo

Information about a delegator for the current reward period.

CCD_DelegatorRewardPeriodInfo

Information about a delegator for the current reward period.

CCD_Description

Description either of an anonymity revoker or identity provider. Metadata that should be visible on the chain.

CCD_ElectionInfo

Contains information related to validator election for a particular block.

CCD_ElectionInfo_Baker

Information about an individual validator's lottery power.

CCD_EncryptedAmountRemovedEvent

Event generated when one or more encrypted amounts are consumed from the account.

CCD_EncryptedBalance

The encrypted balance of a CCD account.

CCD_EncryptedSelfAmountAddedEvent

Event generated when an account adds a self amount from public balance to encrypted balance.

CCD_EpochBakers

The bakers and finalizers for different epochs.

CCD_ExchangeRate

Represents an exchange rate. Value is numerator/denominator.

CCD_FinalizationCommitteeParameters

Finalization committee parameters used from protocol version 6.

CCD_FinalizedBlockInfo

Information about a finalized block that is part of the streaming response.

CCD_FullBakerInfo

Full information about a validator, including identity and keys.

CCD_GasRewards

Distribution of gas rewards for chain parameters version 0 and 1.

CCD_GasRewardsV2

Distribution of gas rewards for chain parameters version 6 and onwards.

CCD_GovernanceAccount

NOT mirrored to an official class.Represents a governance account in the blockchain.

CCD_HigherLevelKeys

Represents root or level 1 keys.

CCD_InclusiveRangeAmountFraction

Inclusive range of amount fractions.

CCD_InitialCredentialValues

Values contained in an initial credential.

CCD_InitializationParameters

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_InstanceInfo

Information about a smart contract instance.

CCD_InstanceInfo_V0

Version 0 smart contract instance information.

CCD_InstanceInfo_V1

Version 1 smart contract instance information.

CCD_InstanceUpdatedEvent

Data generated as part of updating a single contract instance.

CCD_InvokeInstanceResponse

Response from invoking a smart contract instance. Contains either success or failure information.

CCD_InvokeInstanceResponse_Failure

Failure response when invoking a smart contract instance.

CCD_InvokeInstanceResponse_Success

Success response when invoking a smart contract instance.

CCD_IpInfo

Public information about an identity provider.

CCD_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.

CCD_LeverageFactor

A leverage factor.

CCD_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.

CCD_MintDistributionCpv1

Distribution of mint rewards for protocol version 4 and onwards.

CCD_MintRate

A minting rate of CCD. The value is mantissa * 10^(-exponent).

CCD_ModuleAccountState

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_ModuleState

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_NewEncryptedAmountEvent

Event generated when a new self encrypted amount is added to an account.

CCD_NewRelease

A new individual release. Part of a single transfer with schedule transaction.

CCD_NextUpdateSequenceNumbers

The sequence numbers that will be used for the next updates of each kind.

CCD_NormalCredentialValues

Values contained in a normal (non-initial) credential.

CCD_OpenStatusTranslation

Enum representing the open status of a resource.

CCD_PassiveDelegationInfo

Information about the passive delegation pool.

CCD_PendingUpdate

A pending update.

CCD_PersistentRoundStatus

Persistent status of a consensus round that is stored to disk.

CCD_Policy

Policy on a credential.

CCD_PoolInfo

Type for the response of GetPoolInfo. Contains information about a given pool at the end of a given block.

CCD_PoolParametersCpv1

Parameters related to staking pools.

CCD_ProtocolUpdate

A protocol update.

CCD_QuorumMessage

A message in the consensus quorum carrying finalization information.

CCD_QuorumMessages

A collection of quorum messages and aggregated signatures in the consensus protocol.

CCD_Ratio

Represents a ratio, i.e., 'numerator / denominator'.

CCD_RawFinalizationEntry

A raw finalization entry in the consensus protocol.

CCD_RawFinalizerRound

A round of finalization in the consensus protocol.

CCD_RawQuorumCertificate

A raw quorum certificate from the consensus protocol.

CCD_RawTimeoutCertificate

A raw timeout certificate in the consensus protocol.

CCD_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.

CCD_RejectReason_AmountTooLarge

When one wishes to transfer an amount from A to B but there are not enough funds on account/contract A to make this possible. The data are the from address and the amount to transfer.

CCD_RejectReason_DuplicateCredIds

Some of the credential IDs already exist or are duplicated in the transaction.

CCD_RejectReason_InvalidInitMethod

Reference to a non-existing contract init method.

CCD_RejectReason_InvalidReceiveMethod

Reference to a non-existing contract receive method.

CCD_RejectReason_NonExistentCredIds

A credential id that was to be removed is not part of the account.

CCD_RejectReason_RejectedInit

Rejected due to contract logic in init function of a contract.

CCD_RejectReason_RejectedReceive

Rejected due to contract logic in receive function of a contract.

CCD_Release

An individual release of a locked balance.

CCD_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.

CCD_RewardPeriodLength

Length of a reward period in epochs. Must always be a strictly positive number.

CCD_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.

CCD_RoundExistingBlock

An existing block in the consensus round.

CCD_RoundExistingQC

A quorum certificate that exists for a round in consensus.

CCD_RoundStatus

Status of a round in the consensus protocol.

CCD_RoundTimeout

A timeout event in the consensus protocol.

CCD_ShortBlockInfo

CCD_ShortBlockInfo represents some info for a block (custom class).

CCD_StakePendingChange

A pending change to an account's stake. Either a reduction in stake amount, or complete removal of stake.

CCD_StakePendingChange_Reduce

The validator's stake will be reduced at the specified time.

CCD_TimeOutParameters

Parameters controlling timeouts in the consensus protocol.

CCD_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.

CCD_TimeoutMessage

A timeout message in the consensus protocol.

CCD_TimeoutMessages

Lists of timeout messages for different epochs.

CCD_TokenModuleRejectReasonDetails

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_TokenomicsInfo

Contains information related to tokenomics at the end of a given block.

CCD_TokenomicsInfo_V0

Version 0 tokenomics information.

CCD_TokenomicsInfo_V1

Version 1 tokenomics information.

CCD_TransactionFeeDistribution

Parameters determining the distribution of transaction fees.

CCD_TransactionType

Different types of transactions that can be submitted to the chain.

CCD_TransferredWithSchedule

A transfer with schedule was performed. This is the result of a successful TransferWithSchedule transaction.

CCD_UpdateDetails

Details of an update instruction. These are free, and we only ever get a response for them if the update is successfully enqueued, hence no failure cases.

CCD_UpdatePayload

The payload of a chain update.

CCD_ValidatorScoreParameters

Parameters used by the validator scoring system for determining validator suspensions.

CCD_VersionedModuleSource

Different versions of smart contract module sources.

CCD_WinningBaker

Details of which validator won the lottery in a given round in consensus version 1.

CCD_YearMonth

Representation of the pair of a year and month.

CoolDownStatus

Enum representing the different stages of cooldown status.

CredentialDocType

Enum class representing different types of credential documents.

CredentialElement

Enum class representing different types of credential elements.

ProtocolVersions

Enum representing different protocol versions.

Attributes:

Name Type Description
CCD_AccountAddress

String representation of an account address.

CCD_AccountIndex

Index representing an account.

CCD_AccountThreshold

Threshold of signatures required for account operations.

CCD_AmountFraction

Fractional representation of an amount.

CCD_ArIdentity

Represents an anonymity revoker identity.

CCD_ArPublicKey

Public key of an anonymity revoker.

CCD_ArThreshold

Threshold for anonymity revoker operations.

CCD_BakerAggregationVerifyKey

Aggregation verification key for a validator.

CCD_BakerElectionVerifyKey

Election verification key for a validator.

CCD_BakerId

The ID of a validator, which is the index of its account.

CCD_BakerSignatureVerifyKey

Public key used to verify validator signatures.

CCD_BlockHash

Hash representing a block in the blockchain.

CCD_BlockSignature

A signature on a block.

CCD_Cbor

A CBOR encoded bytestring

CCD_Commitment

Commitment value used in cryptographic operations.

CCD_ContractEvent

Event related to a smart contract execution.

CCD_ContractStateV0

Version 0 representation of contract state.

CCD_CredentialRegistrationId

Unique identifier for credential registration.

CCD_CredentialsPerBlockLimit

Maximum number of credentials allowed per block.

CCD_DelegatorId

Delegator ID, which is the same as an account index.

CCD_Duration

General representation of a duration (may be in different units).

CCD_DurationSeconds

Duration represented in seconds.

CCD_ElectionDifficulty

Represents the difficulty level in the election process.

CCD_Empty

Represents an empty or null value.

CCD_EncryptedAmount

Encrypted representation of an amount.

CCD_Energy

Represents the amount of energy consumed or available.

CCD_Epoch

Represents an epoch number in the blockchain.

CCD_FinalizationCommitteeHash

A hash of the finalization committee members and their stakes.

CCD_FinalizerIndex

Unique identifier for a Finalizer.

CCD_IdentityProviderIdentity

Identity of an identity provider.

CCD_InitName

Name of the initialization function for a smart contract.

CCD_IpCdiVerifyKey

Credential deployment information verification key of an identity provider.

CCD_IpIdentity

Represents an identity provider identity.

CCD_IpVerifyKey

Verification key of an identity provider.

CCD_LeadershipElectionNonce

Nonce used for leadership election.

CCD_Memo

Memo field for transactions or messages.

CCD_ModuleRef

Reference to a smart contract module.

CCD_OpenStatus

Status indicator for openness (e.g., open, closed, restricted).

CCD_Parameter

Parameters passed to a smart contract function.

CCD_Policy_Attributes

Attributes defining a policy.

CCD_ProtocolVersion

Protocol version of the blockchain.

CCD_QuorumSignature

The bytes representing the raw aggregate signature. The bytes have a fixed length of 48 bytes.

CCD_ReceiveName

Name of a smart contract receive function.

CCD_RegisteredData

Registered on-chain data associated with an account.

CCD_Round

Round number in consensus or other processes.

CCD_SequenceNumber

Sequence number used for ordering transactions or events.

CCD_Sha256Hash

SHA-256 hash representation.

CCD_SignatureThreshold

Threshold for signature verification.

CCD_StakePendingChange_Remove

Timestamp representing when a stake pending change will be removed.

CCD_StateHash

State hash representing a snapshot of blockchain state.

CCD_SuccessorProof

A cryptographic proof showing that one block is a valid successor of another.

CCD_TimeStamp

Timestamp representing a point in time.

CCD_TimeoutSignature

A signature on a timeout message.

CCD_TokenId

Token ID: a unique symbol and identifier of a protocol level token.

CCD_TokenModuleRef

A token module reference. This is always 32 bytes long.

CCD_TransactionHash

Hash representing a transaction.

CCD_TransactionTime

Timestamp representing the time of a transaction.

CCD_UpdateKeysIndex

Index of the update key.

CCD_UpdateKeysThreshold

Threshold for update key signatures.

CCD_UpdatePublicKey

Public key used for blockchain updates.

CCD_VersionedModuleSource_ModuleSourceV0

Versioned module source, version 0.

CCD_VersionedModuleSource_ModuleSourceV1

Versioned module source, version 1.

microCCD

Smallest unit of CCD (1 microCCD = 10^-6 CCD).

CCD_AccountAddress = str module-attribute

String representation of an account address.

CCD_AccountIndex = int module-attribute

Index representing an account.

CCD_AccountThreshold = int module-attribute

Threshold of signatures required for account operations.

CCD_AmountFraction = float module-attribute

Fractional representation of an amount.

CCD_ArIdentity = int module-attribute

Represents an anonymity revoker identity.

CCD_ArPublicKey = str module-attribute

Public key of an anonymity revoker.

CCD_ArThreshold = int module-attribute

Threshold for anonymity revoker operations.

CCD_BakerAggregationVerifyKey = str module-attribute

Aggregation verification key for a validator.

CCD_BakerElectionVerifyKey = str module-attribute

Election verification key for a validator.

CCD_BakerId = int module-attribute

The ID of a validator, which is the index of its account.

CCD_BakerSignatureVerifyKey = str module-attribute

Public key used to verify validator signatures.

CCD_BlockHash = str module-attribute

Hash representing a block in the blockchain.

CCD_BlockSignature = str module-attribute

A signature on a block.

CCD_Cbor = str module-attribute

A CBOR encoded bytestring

CCD_Commitment = str module-attribute

Commitment value used in cryptographic operations.

CCD_ContractEvent = str module-attribute

Event related to a smart contract execution.

CCD_ContractStateV0 = str module-attribute

Version 0 representation of contract state.

CCD_CredentialRegistrationId = str module-attribute

Unique identifier for credential registration.

CCD_CredentialsPerBlockLimit = int module-attribute

Maximum number of credentials allowed per block.

CCD_DelegatorId = CCD_AccountIndex module-attribute

Delegator ID, which is the same as an account index.

CCD_Duration = int module-attribute

General representation of a duration (may be in different units).

CCD_DurationSeconds = int module-attribute

Duration represented in seconds.

CCD_ElectionDifficulty = float module-attribute

Represents the difficulty level in the election process.

CCD_Empty = None module-attribute

Represents an empty or null value.

CCD_EncryptedAmount = str module-attribute

Encrypted representation of an amount.

CCD_Energy = int module-attribute

Represents the amount of energy consumed or available.

CCD_Epoch = int module-attribute

Represents an epoch number in the blockchain.

CCD_FinalizationCommitteeHash = str module-attribute

A hash of the finalization committee members and their stakes.

CCD_FinalizerIndex = int module-attribute

Unique identifier for a Finalizer.

CCD_IdentityProviderIdentity = int module-attribute

Identity of an identity provider.

CCD_InitName = str module-attribute

Name of the initialization function for a smart contract.

CCD_IpCdiVerifyKey = str module-attribute

Credential deployment information verification key of an identity provider.

CCD_IpIdentity = int module-attribute

Represents an identity provider identity.

CCD_IpVerifyKey = str module-attribute

Verification key of an identity provider.

CCD_LeadershipElectionNonce = str module-attribute

Nonce used for leadership election.

CCD_Memo = str module-attribute

Memo field for transactions or messages.

CCD_ModuleRef = str module-attribute

Reference to a smart contract module.

CCD_OpenStatus = int module-attribute

Status indicator for openness (e.g., open, closed, restricted).

CCD_Parameter = str module-attribute

Parameters passed to a smart contract function.

CCD_Policy_Attributes = str module-attribute

Attributes defining a policy.

CCD_ProtocolVersion = int module-attribute

Protocol version of the blockchain.

CCD_QuorumSignature = str module-attribute

The bytes representing the raw aggregate signature. The bytes have a fixed length of 48 bytes.

CCD_ReceiveName = str module-attribute

Name of a smart contract receive function.

CCD_RegisteredData = str module-attribute

Registered on-chain data associated with an account.

CCD_Round = int module-attribute

Round number in consensus or other processes.

CCD_SequenceNumber = int module-attribute

Sequence number used for ordering transactions or events.

CCD_Sha256Hash = str module-attribute

SHA-256 hash representation.

CCD_SignatureThreshold = int module-attribute

Threshold for signature verification.

CCD_StakePendingChange_Remove = CCD_TimeStamp module-attribute

Timestamp representing when a stake pending change will be removed.

CCD_StateHash = str module-attribute

State hash representing a snapshot of blockchain state.

CCD_SuccessorProof = str module-attribute

A cryptographic proof showing that one block is a valid successor of another.

CCD_TimeStamp = dt.datetime module-attribute

Timestamp representing a point in time.

CCD_TimeoutSignature = str module-attribute

A signature on a timeout message.

CCD_TokenId = str module-attribute

Token ID: a unique symbol and identifier of a protocol level token.

CCD_TokenModuleRef = str module-attribute

A token module reference. This is always 32 bytes long.

CCD_TransactionHash = str module-attribute

Hash representing a transaction.

CCD_TransactionTime = int module-attribute

Timestamp representing the time of a transaction.

CCD_UpdateKeysIndex = int module-attribute

Index of the update key.

CCD_UpdateKeysThreshold = int module-attribute

Threshold for update key signatures.

CCD_UpdatePublicKey = str module-attribute

Public key used for blockchain updates.

CCD_VersionedModuleSource_ModuleSourceV0 = str module-attribute

Versioned module source, version 0.

CCD_VersionedModuleSource_ModuleSourceV1 = str module-attribute

Versioned module source, version 1.

microCCD = int module-attribute

Smallest unit of CCD (1 microCCD = 10^-6 CCD).

CCD_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.

GRPC documentation: concordium.v2.AccessStructure

Attributes:

Name Type Description
access_public_keys list[CCD_UpdateKeysIndex]

Unique indexes into the set of keys in AuthorizationV0.

access_threshold CCD_UpdateKeysThreshold

Number of keys required to authorize an update.

CCD_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.

GRPC documentation: concordium.v2.AccountCreationDetails

Attributes:

Name Type Description
credential_type CredentialType

Whether this is an initial or normal account.

address CCD_AccountAddress

Address of the newly created account.

reg_id CCD_CredentialRegistrationId

Credential registration ID of the first credential.

CCD_AccountCredential

Credential that is part of an account.

GRPC documentation: concordium.v2.AccountCredential

Attributes:

Name Type Description
initial Optional[CCD_InitialCredentialValues]

Values for an initial credential that creates an account.

normal Optional[CCD_NormalCredentialValues]

Values for a normal (non-initial) credential.

CCD_AccountInfo

Information about the account at a particular point in time.

GRPC documentation: concordium.v2.AccountInfo

Attributes:

Name Type Description
sequence_number CCD_SequenceNumber

Next sequence number to be used for transactions signed from this account.

amount microCCD

Current (unencrypted) balance of the account.

schedule CCD_ReleaseSchedule

Release schedule for any locked up amount. This could be an empty release schedule.

creds dict[int, CCD_AccountCredential]

Map of all currently active credentials on the account. This includes public keys that can sign for the given credentials, as well as any revealed attributes. This map always contains a credential with index 0.

threshold CCD_AccountThreshold

Lower bound on how many credentials must sign any given transaction from this account.

encrypted_balance CCD_EncryptedBalance

The encrypted balance of the account.

encryption_key CCD_EncryptionKey

The public key for sending encrypted balances to the account.

index CCD_AccountIndex

Internal index of the account. Accounts on the chain get sequential indices. These should generally not be used outside of the chain, the account address is meant to be used to refer to accounts.

stake Optional[CCD_AccountStakingInfo]

Present if the account is a validator or delegator. In that case it is the information about the validator or delegator.

address CCD_AccountAddress

Canonical address of the account. This is derived from the first credential that created the account.

cooldowns list[CCD_Cooldown]

The stake on the account that is in cooldown.

available_balance microCCD

The available (unencrypted) balance of the account that can be transferred or used to pay for transactions.

CCD_AccountPending

Information about a pending account.

GRPC documentation: concordium.v2.AccountPending

Attributes:

Name Type Description
account_index CCD_AccountIndex

The index of the pending account.

first_timestamp CCD_TimeStamp

The timestamp of when the account was first seen.

CCD_AccountStakingInfo

Information about the account stake, if the account is either a validator or a delegator.

GRPC documentation: concordium.v2.AccountStakingInfo

Attributes:

Name Type Description
validator Optional[CCD_AccountStakingInfo_Baker]

The account is a validator.

delegator Optional[CCD_AccountStakingInfo_Delegator]

The account is a delegator.

CCD_AccountStakingInfo_Baker

Information about an account that is registered as a validator.

GRPC documentation: concordium.v2.AccountStakingInfo.Validator

Attributes:

Name Type Description
staked_amount microCCD

Amount staked at present.

restake_earnings bool

Whether rewards paid to the validator are automatically restaked.

baker_info CCD_BakerInfo

Information about the validator that is staking.

pending_change Optional[CCD_StakePendingChange]

Any pending change to the delegated stake.

pool_info Optional[CCD_BakerPoolInfo]

Present if the account is currently a validator, i.e., it is in the baking committee of the current epoch.

is_suspended bool

Whether the account is currently suspended. Has meaning from protocol version 8 onwards. In protocol version 8 it signals whether an account has been suspended and is not participating in the consensus algorithm. For protocol version < 8 the flag will always be false.

CCD_AccountStakingInfo_Delegator

Information about an account that has delegated its stake to a pool.

GRPC documentation: concordium.v2.AccountStakingInfo.Delegator

Attributes:

Name Type Description
staked_amount microCCD

The amount that the account delegates.

restake_earnings bool

Whether the earnings are automatically added to the staked amount.

target CCD_DelegationTarget

The entity to which the account delegates.

pending_change Optional[CCD_StakePendingChange]

If present, any pending change to the delegated stake.

CCD_AccountTransactionDetails

Details about an account transaction.

GRPC documentation: concordium.v2.AccountTransactionDetails

Attributes:

Name Type Description
cost microCCD

The cost of the transaction. Paid by the sender.

sender CCD_AccountAddress

The sender of the transaction.

effects CCD_AccountTransactionEffects

The effects of the transaction.

CCD_AccountTransactionEffects

Effects of an account transaction. All variants except None correspond to a unique transaction that was successful.

GRPC documentation: concordium.v2.AccountTransactionEffects

Attributes:

Name Type Description
none Optional[CCD_AccountTransactionEffects_None]

No effects other than payment from this transaction.

module_deployed Optional[CCD_ModuleRef]

A smart contract module with the attached reference was deployed.

contract_initialized Optional[CCD_ContractInitializedEvent]

A smart contract was initialized.

contract_update_issued Optional[CCD_ContractUpdateIssued]

A smart contract instance update was issued.

account_transfer Optional[CCD_AccountTransfer]

A simple account to account transfer occurred.

baker_added Optional[CCD_BakerAdded]

A validator was added.

baker_removed Optional[CCD_BakerId]

A validator was removed.

baker_stake_updated Optional[CCD_BakerStakeUpdated]

A validator's stake was updated.

baker_restake_earnings_updated Optional[CCD_BakerEvent_BakerRestakeEarningsUpdated]

A validator's restake earnings setting was updated.

baker_keys_updated Optional[CCD_BakerKeysEvent]

A validator's keys were updated.

encrypted_amount_transferred Optional[CCD_AccountTransactionEffects_EncryptedAmountTransferred]

An encrypted amount was transferred.

transferred_to_encrypted Optional[CCD_EncryptedSelfAmountAddedEvent]

An account transferred part of its public balance to its encrypted balance.

transferred_to_public Optional[CCD_AccountTransactionEffects_TransferredToPublic]

An account transferred part of its encrypted balance to its public balance.

transferred_with_schedule Optional[CCD_TransferredWithSchedule]

A transfer with a release schedule was made.

credential_keys_updated Optional[CCD_CredentialRegistrationId]

Keys of a specific credential were updated.

credentials_updated Optional[CCD_AccountTransactionEffects_CredentialsUpdated]

Account credentials were updated.

data_registered Optional[CCD_RegisteredData]

Some data was registered on the chain.

baker_configured Optional[CCD_BakerConfigured]

A validator was configured.

delegation_configured Optional[CCD_DelegationConfigured]

A delegator was configured.

CCD_AccountTransactionEffects_CredentialsUpdated

Event generated when account credentials are updated.

GRPC documentation: concordium.v2.AccountTransactionEffects.CredentialsUpdated

Attributes:

Name Type Description
new_cred_ids list[CCD_CredentialRegistrationId]

The new credential IDs added to the account.

removed_cred_ids list[CCD_CredentialRegistrationId]

The credential IDs removed from the account.

new_threshold CCD_AccountThreshold

The new account threshold.

CCD_AccountTransactionEffects_EncryptedAmountTransferred

Event generated when transferring an encrypted amount.

GRPC documentation: concordium.v2.AccountTransactionEffects.EncryptedAmountTransferred

Attributes:

Name Type Description
removed Optional[CCD_EncryptedAmountRemovedEvent]

Event generated when removing an encrypted amount from the sender.

added Optional[CCD_NewEncryptedAmountEvent]

Event generated when adding the encrypted amount to the receiver.

memo Optional[CCD_Memo]

An optional memo attached to the transfer.

CCD_AccountTransactionEffects_None

No effects other than payment from this transaction. The rejection reason indicates why the transaction failed.

GRPC documentation: concordium.v2.AccountTransactionEffects.None

Attributes:

Name Type Description
transaction_type Optional[int]

Transaction type of a failed transaction, if known.

reject_reason CCD_RejectReason

Reason for rejection of the transaction.

CCD_AccountTransactionEffects_TransferredToPublic

Event generated when an amount is transferred from encrypted to public balance.

GRPC documentation: concordium.v2.AccountTransactionEffects.TransferredToPublic

Attributes:

Name Type Description
removed CCD_EncryptedAmountRemovedEvent

Event generated when removing an encrypted amount.

amount microCCD

The amount that was made public.

CCD_AccountTransfer

A simple transfer of CCD tokens from one account to another.

GRPC documentation: concordium.v2.AccountTransfer

Attributes:

Name Type Description
amount microCCD

The amount that was transferred.

receiver CCD_AccountAddress

The account that received the amount.

memo Optional[CCD_Memo]

An optional memo attached to the transfer.

CCD_AccountVerifyKey

A public key used to verify transaction signatures from an account.

GRPC documentation: concordium.v2.AccountVerifyKey

Attributes:

Name Type Description
ed25519_key Optional[str]

An Ed25519 public key.

CCD_Address

An address of either a contract or an account.

GRPC documentation: concordium.v2.Address

Attributes:

Name Type Description
account Optional[CCD_AccountAddress]

The account address if this is an account address.

contract Optional[CCD_ContractAddress]

The contract address if this is a contract address.

CCD_AggregatedSignatures

Aggregated signatures from a set of finalizers.

GRPC documentation: concordium.v2.AggregatedSignatures

Attributes:

Name Type Description
signed_block CCD_BlockHash

The hash of the signed block.

signature_weight microCCD

The weight of the signature.

aggregate_signature CCD_QuorumSignature

The aggregate signature.

signatories list[CCD_FinalizerIndex]

The list of finalizer indices who signed the block.

CCD_ArInfo

Information on a single anonymity revoker help by the identity provider. Typically an identity provider will hold more than one.

GRPC documentation: concordium.v2.ArInfo

Attributes:

Name Type Description
identity CCD_ArIdentity

Identity of the anonymity revoker on the chain. This defines their evaluation point for secret sharing, and thus it cannot be 0.

description CCD_Description

Description of the anonymity revoker.

public_key CCD_ArPublicKey

Elgamal encryption key of the anonymity revoker.

CCD_ArrivedBlockInfo

Information about an arrived block that is part of the streaming response.

GRPC documentation: concordium.v2.ArrivedBlockInfo

Attributes:

Name Type Description
hash CCD_BlockHash

Hash of the block.

height int

Absolute height of the block, height 0 is the genesis block.

CCD_AuthorizationsV0

The set of keys authorized for chain updates, together with access structures determining which keys are authorized for which update types.

GRPC documentation: concordium.v2.AuthorizationsV0

Attributes:

Name Type Description
keys list[CCD_UpdatePublicKey]

The set of keys authorized for chain updates.

emergency CCD_AccessStructure

New emergency keys.

protocol CCD_AccessStructure

New protocol update keys.

parameter_consensus CCD_AccessStructure

Access structure for updating the consensus parameters. Previously, this was the election difficulty.

parameter_euro_per_energy CCD_AccessStructure

Access structure for updating the euro per energy.

parameter_micro_CCD_per_euro CCD_AccessStructure

Access structure for updating the micro CCD per euro.

parameter_foundation_account CCD_AccessStructure

Access structure for updating the foundation account.

parameter_mint_distribution CCD_AccessStructure

Access structure for updating the mint distribution.

parameter_transaction_fee_distribution CCD_AccessStructure

Access structure for updating the transaction fee distribution.

parameter_gas_rewards CCD_AccessStructure

Access structure for updating the gas rewards.

pool_parameters CCD_AccessStructure

Access structure for updating the pool parameters. For V0 this is only the validator stake threshold, for V1 there are more.

add_anonymity_revoker CCD_AccessStructure

Access structure for adding new anonymity revokers.

add_identity_provider CCD_AccessStructure

Access structure for adding new identity providers.

CCD_AuthorizationsV1

The set of keys authorized for chain updates, together with access structures determining which keys are authorized for which update types. Similar to AuthorizationsV0 except that a few more keys can be updated.

GRPC documentation: concordium.v2.AuthorizationsV1

Attributes:

Name Type Description
v0 CCD_AuthorizationsV0

The base V0 authorizations.

parameter_cooldown CCD_AccessStructure

Access structure for updating the cooldown periods related to baking and delegation.

parameter_time CCD_AccessStructure

Access structure for updating the length of the reward period.

CCD_BakerAdded

Data generated when a new validator is added.

GRPC documentation: concordium.v2.BakerEvent.BakerAdded

Attributes:

Name Type Description
keys_event CCD_BakerKeysEvent

Event containing all the keys of the validator.

stake microCCD

The initial stake amount.

restake_earnings bool

Whether the validator's earnings will be added to their stake.

CCD_BakerConfigured

A validator was configured. The details of what happened are contained in the list of BakerEvents.

GRPC documentation: concordium.v2.AccountTransactionEffects.BakerConfigured

Attributes:

Name Type Description
events list[CCD_BakerEvent]

The events detailing how the validator was configured.

CCD_BakerEvent

Events that may result from the ConfigureBaker transaction.

GRPC documentation: concordium.v2.BakerEvent

Attributes:

Name Type Description
baker_added Optional[CCD_BakerAdded]

A validator was added.

baker_removed Optional[CCD_BakerId]

A validator was removed.

baker_stake_increased Optional[CCD_BakerStakeIncreased]

The validator's stake was increased.

baker_stake_decreased Optional[CCD_BakerStakeDecreased]

The validator's stake was decreased.

baker_restake_earnings_updated Optional[CCD_BakerRestakeEarningsUpdated]

The validator's setting for restaking earnings was updated.

baker_keys_updated Optional[CCD_BakerKeysEvent]

Validator keys were updated.

baker_set_open_status Optional[CCD_BakerSetOpenStatus]

The validator's open status was updated.

baker_set_metadata_url Optional[CCD_BakerSetMetadataUrl]

The validator's metadata URL was updated.

baker_set_transaction_fee_commission Optional[CCD_BakerSetTransactionFeeCommission]

The validator's transaction fee commission was updated.

baker_set_baking_reward_commission Optional[CCD_BakerSetBakingRewardCommission]

The validator's baking reward commission was updated.

baker_set_finalization_reward_commission Optional[CCD_BakerSetFinalizationRewardCommission]

The validator's finalization reward commission was updated.

delegation_removed Optional[CCD_DelegatorId]

An existing delegator was removed.

baker_suspended Optional[CCD_BakerId]

The validator's account has been suspended.

baker_resumed Optional[CCD_BakerId]

The validator's account has been resumed.

CCD_BakerEvent_BakerRestakeEarningsUpdated

A validator's setting for restaking earnings was updated.

GRPC documentation: concordium.v2.BakerEvent.BakerRestakeEarningsUpdated

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

restake_earnings bool

The new value of the flag.

CCD_BakerInfo

Information about a validator.

GRPC documentation: concordium.v2.BakerInfo

Attributes:

Name Type Description
baker_id CCD_BakerId

Identity of the validator. This is actually the account index of the account controlling the validator.

election_key CCD_BakerElectionVerifyKey

Validator's public key used to check whether they won the lottery or not.

signature_key CCD_BakerSignatureVerifyKey

Validator's public key used to check that they are indeed the ones who produced the block.

aggregation_key CCD_BakerAggregationVerifyKey

Validator's public key used to check signatures on finalization records. This is only used if the validator has sufficient stake to participate in finalization.

CCD_BakerKeysEvent

Event containing all keys of a validator, including aggregation key.

GRPC documentation: concordium.v2.BakerKeysEvent

Attributes:

Name Type Description
baker_id CCD_BakerId

The validator ID.

account CCD_AccountAddress

The account address of the validator.

sign_key CCD_BakerSignatureVerifyKey

The key used to verify block and consensus signatures.

election_key CCD_BakerElectionVerifyKey

The key used to verify leadership proofs.

aggregation_key CCD_BakerAggregationVerifyKey

The key used to verify aggregation of finalization proofs.

CCD_BakerPoolInfo

Additional information about a validator pool.

GRPC documentation: concordium.v2.BakerPoolInfo

Attributes:

Name Type Description
commission_rates CCD_CommissionRates

The commission rates charged by the pool owner.

url str

The URL that links to the metadata about the pool.

open_status OpenStatus

Whether the pool allows delegators.

CCD_BakerRestakeEarningsUpdated

A validator's setting for restaking earnings was updated.

GRPC documentation: concordium.v2.BakerEvent.BakerRestakeEarningsUpdated

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

restake_earnings bool

The new value of the flag.

CCD_BakerResumed

Data generated when a baker is resumed after being suspended.

GRPC documentation: concordium.v2.BakerEvent.BakerResumed

Attributes:

Name Type Description
baker_id CCD_BakerId

The baker ID.

CCD_BakerSetBakingRewardCommission

Updated baking reward commission for validator pool.

GRPC documentation: concordium.v2.BakerEvent.BakerSetBakingRewardCommission

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

baking_reward_commission AmountFraction

The baking reward commission.

CCD_BakerSetFinalizationRewardCommission

Updated finalization reward commission for validator pool.

GRPC documentation: concordium.v2.BakerEvent.BakerSetFinalizationRewardCommission

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

finalization_reward_commission AmountFraction

The finalization reward commission.

CCD_BakerSetMetadataUrl

Updated metadata url for a validator pool.

GRPC documentation: concordium.v2.BakerEvent.BakerSetMetadataUrl

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

url str

The URL.

CCD_BakerSetOpenStatus

Updated open status for a validator pool.

GRPC documentation: concordium.v2.BakerEvent.BakerSetOpenStatus

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

open_status OpenStatus

The new open status.

CCD_BakerSetTransactionFeeCommission

Updated transaction fee commission for a validator pool.

GRPC documentation: concordium.v2.BakerEvent.BakerSetTransactionFeeCommission

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

transaction_fee_commission AmountFraction

The transaction fee commission.

CCD_BakerStakeDecreased

Validator stake decreased.

GRPC documentation: concordium.v2.BakerEvent.BakerStakeDecreased

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

new_stake microCCD

The new stake.

CCD_BakerStakeIncreased

Validator stake increased.

GRPC documentation: concordium.v2.BakerEvent.BakerStakeIncreased

Attributes:

Name Type Description
baker_id CCD_BakerId

Validator's id.

new_stake microCCD

The new stake.

CCD_BakerStakePendingChange

A pending change to a validator's staking. Either a reduction in stake amount, or complete removal of stake.

GRPC documentation: concordium.v2.BakerStakePendingChange

Attributes:

Name Type Description
reduce Optional[CCD_BakerStakePendingChange_Reduce]

Details of a pending reduction in validator's stake.

remove Optional[CCD_BakerStakePendingChange_Remove]

Details of a pending removal of validator's stake.

CCD_BakerStakePendingChange_Reduce

The validator's equity capital will be reduced at the specified time.

GRPC documentation: concordium.v2.BakerStakePendingChange.Reduce

Attributes:

Name Type Description
reduced_equity_capital microCCD

The reduced equity capital amount.

effective_time CCD_TimeStamp

The time at which the reduction takes effect.

CCD_BakerStakePendingChange_Remove

The validator's stake will be removed at the specified time.

GRPC documentation: concordium.v2.BakerStakePendingChange.Remove

Attributes:

Name Type Description
effective_time CCD_TimeStamp

The time at which the removal takes effect.

CCD_BakerStakeThreshold

Minimum stake needed to become a validator. This only applies to protocol version 1-3.

GRPC documentation: concordium.v2.BakerStakeThreshold

Attributes:

Name Type Description
baker_stake_threshold Amount

Minimum threshold required for registering as a validator.

CCD_BakerStakeUpdated

An account was deregistered as a validator. This is the result of a successful UpdateBakerStake transaction.

GRPC documentation: concordium.v2.AccountTransactionEffects.BakerStakeUpdated

Attributes:

Name Type Description
update Optional[CCD_BakerStakeUpdatedData]

If the stake was updated (that is, it changed and did not stay the same) then this is present, otherwise it is not present.

CCD_BakerStakeUpdatedData

Validator stake updated data.

GRPC documentation: concordium.v2.BakerStakeUpdatedData

Attributes:

Name Type Description
baker_id CCD_BakerId

Affected validator.

new_stake microCCD

New stake.

increased bool

A boolean which indicates whether it increased (true) or decreased (false).

CCD_BakersAndFinalizers

The set of bakers and finalizers in a particular consensus epoch.

GRPC documentation: concordium.v2.BakersAndFinalizers

Attributes:

Name Type Description
bakers [list[CCD_FullBakerInfo]

List of all bakers and their stakes and keys.

finalizers [list[CCD_BakerId]

List of validator IDs who are finalizers.

baker_total_stake [microCCD

The total stake of all bakers.

finalizer_total_stake [microCCD

The total stake of all finalizers.

finalization_committee_hash [CCD_FinalizationCommitteeHash

Hash of the finalization committee.

CCD_Block

CCD_Block represents the txs from a block (custom class)

Attributes:

Name Type Description
transaction_summaries list[CCD_BlockItemSummary]

A list of summaries for each transaction in the block.

CCD_BlockComplete

CCD_BlockComplete represents a complete block, including block_info, transaction_summaries and special_events, as well as logged_events.

Attributes:

Name Type Description
block_info CCD_BlockInfo

Information about the block.

transaction_summaries list[CCD_BlockItemSummary]

Summaries of the transactions in the block.

special_events list[CCD_BlockSpecialEvent]

Special events associated with the block.

logged_events Optional[list]

Logged events related to the block. This attribute is optional and may lead to circular imports if specific types are used.

net Optional[str]

Network identifier. This attribute is optional.

CCD_BlockInfo

Information about a block.

GRPC documentation: concordium.v2.BlockInfo

Attributes:

Name Type Description
arrive_time Optional[CCD_TimeStamp]

Time the block was verified.

validator Optional[int]

ID of the validator of this block.

hash CCD_BlockHash

Hash of the block.

height int

Absolute height of the block.

last_finalized_block CCD_BlockHash

The last finalized block when this block was baked.

parent_block CCD_BlockHash

The parent block hash.

receive_time Optional[CCD_TimeStamp]

Time the block was received.

slot_number Optional[int]

The slot number in which the block was baked.

slot_time CCD_TimeStamp

Time of the slot in which the block was baked.

era_block_height int

The height relative to genesis.

finalized bool

Whether the block is finalized.

genesis_index int

The genesis index for this block.

transaction_count int

The number of transactions in the block.

transactions_energy_cost int

The total energy cost of the transactions in the block.

transactions_size int

The total size of the transactions in the block.

transaction_hashes Optional[list[CCD_TransactionHash]]

The hashes of the transactions in the block.

state_hash Optional[CCD_StateHash]

The state hash of the block.

protocol_version Optional[str]

The protocol version of the block.

round Optional[CCD_Round]

The round in which the block was created.

epoch Optional[CCD_Epoch]

The epoch in which the block was created.

CCD_BlockItemSummary

Summary of the outcome of a block item in structured form. The summary determines which transaction type it was.

GRPC documentation: concordium.v2.BlockItemSummary

Attributes:

Name Type Description
index TransactionIndex

Index of the transaction in the block where it is included.

energy_cost Energy

The amount of NRG the transaction cost.

hash CCD_TransactionHash

Hash of the transaction.

account_transaction Optional[CCD_AccountTransactionDetails]

Details about an account transaction.

account_creation Optional[CCD_AccountCreationDetails]

Details about an account creation.

update Optional[CCD_UpdateDetails]

Details about a chain update.

block_info Optional[CCD_ShortBlockInfo]

Short information about the block.

recognized_sender_id Optional[str]

The recognized sender ID if available.

CCD_BlockSpecialEvent

A protocol generated event that is not directly caused by a transaction. This includes minting new CCD, rewarding different bakers and delegators, etc.

GRPC documentation: concordium.v2.BlockSpecialEvent

Attributes:

Name Type Description
baking_rewards Optional[CCD_BlockSpecialEvent_BakingRewards]

Payment to each validator of a previous epoch, in proportion to blocks contributed.

mint Optional[CCD_BlockSpecialEvent_Mint]

Minting of new CCD.

finalization_rewards Optional[CCD_BlockSpecialEvent_FinalizationRewards]

Payment to each finalizer on inclusion of a finalization record.

block_reward Optional[CCD_BlockSpecialEvent_BlockReward]

Disbursement of fees from a block between GAS account, validator, and foundation.

payday_foundation_reward Optional[CCD_BlockSpecialEvent_PaydayFoundationReward]

Foundation tax.

payday_account_reward Optional[CCD_BlockSpecialEvent_PaydayAccountReward]

Reward payment to a given account.

block_accrue_reward Optional[CCD_BlockSpecialEvent_BlockAccrueReward]

Amounts accrued to accounts for each baked block.

payday_pool_reward Optional[CCD_BlockSpecialEvent_PaydayPoolReward]

Payment distributed to a pool or passive delegators.

validator_suspended Optional[CCD_BlockSpecialEvent_ValidatorSuspended]

A validator that got suspended due to too many missed rounds.

validator_primed_for_suspension Optional[CCD_BlockSpecialEvent_ValidatorPrimedForSuspension]

A validator primed for suspension at next snapshot epoch.

CCD_BlockSpecialEvent_AccountAmounts

A representation of a mapping from an account address to an amount.

GRPC documentation: concordium.v2.BlockSpecialEvent.AccountAmounts

Attributes:

Name Type Description
entries list[CCD_BlockSpecialEvent_AccountAmounts_Entry]

List of entries mapping from account addresses to amounts.

CCD_BlockSpecialEvent_AccountAmounts_Entry

Entry for mapping from an account address to an amount.

GRPC documentation: concordium.v2.BlockSpecialEvent.AccountAmounts.Entry

Attributes:

Name Type Description
account CCD_AccountAddress

The account address.

amount microCCD

The amount associated with the account.

CCD_BlockSpecialEvent_BakingRewards

Payment to each validator of a previous epoch, in proportion to the number of blocks they contributed.

GRPC documentation: concordium.v2.BlockSpecialEvent.BakingRewards

Attributes:

Name Type Description
baker_rewards CCD_BlockSpecialEvent_AccountAmounts

The amount awarded to each validator.

remainder microCCD

The remaining balance of the validator reward account.

CCD_BlockSpecialEvent_BlockAccrueReward

Amounts accrued to accounts for each baked block.

GRPC documentation: concordium.v2.BlockSpecialEvent.BlockAccrueReward

Attributes:

Name Type Description
transaction_fees microCCD

The total fees paid for transactions in the block.

old_gas_account microCCD

The old balance of the GAS account.

new_gas_account microCCD

The new balance of the GAS account.

baker_reward microCCD

The amount awarded to the validator.

passive_reward microCCD

The amount awarded to the passive delegators.

foundation_charge microCCD

The amount awarded to the foundation.

validator CCD_BakerId

The validator of the block, who will receive the award.

CCD_BlockSpecialEvent_BlockReward

Disbursement of fees from a block between the GAS account, the validator, and the foundation. It should always be that: transaction_fees + old_gas_account = new_gas_account + baker_reward + foundation_charge

GRPC documentation: concordium.v2.BlockSpecialEvent.BlockReward

Attributes:

Name Type Description
transaction_fees microCCD

The total fees paid for transactions in the block.

old_gas_account microCCD

The old balance of the GAS account.

new_gas_account microCCD

The new balance of the GAS account.

baker_reward microCCD

The amount awarded to the validator.

foundation_charge microCCD

The amount awarded to the foundation.

validator CCD_AccountAddress

The validator of the block, who receives the award.

foundation_account CCD_AccountAddress

The foundation account.

CCD_BlockSpecialEvent_FinalizationRewards

Payment to each finalizer on inclusion of a finalization record in a block.

GRPC documentation: concordium.v2.BlockSpecialEvent.FinalizationRewards

Attributes:

Name Type Description
finalization_rewards CCD_BlockSpecialEvent_AccountAmounts

The amount awarded to each finalizer.

remainder microCCD

The remaining balance of the finalization reward account.

CCD_BlockSpecialEvent_Mint

Minting of new CCD.

GRPC documentation: concordium.v2.BlockSpecialEvent.Mint

Attributes:

Name Type Description
mint_baking_reward microCCD

The amount allocated to the banking reward account.

mint_finalization_reward microCCD

The amount allocated to the finalization reward account.

mint_platform_development_charge microCCD

The amount allocated as the platform development charge.

foundation_account CCD_AccountAddress

The account to which the platform development charge is paid.

CCD_BlockSpecialEvent_PaydayAccountReward

Reward payment to the given account.

GRPC documentation: concordium.v2.BlockSpecialEvent.PaydayAccountReward

Attributes:

Name Type Description
account CCD_AccountAddress

The account that got rewarded.

transaction_fees microCCD

The transaction fee reward at payday to the account.

baker_reward microCCD

The baking reward at payday to the account.

finalization_reward microCCD

The finalization reward at payday to the account.

CCD_BlockSpecialEvent_PaydayFoundationReward

Foundation tax.

GRPC documentation: concordium.v2.BlockSpecialEvent.PaydayFoundationReward

Attributes:

Name Type Description
foundation_account CCD_AccountAddress

The account that got rewarded.

development_charge microCCD

The transaction fee reward at payday to the account.

CCD_BlockSpecialEvent_PaydayPoolReward

Payment distributed to a pool or passive delegators.

GRPC documentation: concordium.v2.BlockSpecialEvent.PaydayPoolReward

Attributes:

Name Type Description
pool_owner Optional[CCD_BakerId]

The pool owner (None for passive delegators).

transaction_fees microCCD

Accrued transaction fees for pool.

baker_reward microCCD

Accrued block production rewards for pool.

finalization_reward microCCD

Accrued finalization rewards for pool.

CCD_BlockSpecialEvent_ValidatorPrimedForSuspension

The id of a validator that is primed for suspension at the next snapshot epoch due to too many missed rounds.

GRPC documentation: concordium.v2.BlockSpecialEvent.ValidatorPrimedForSuspension

Attributes:

Name Type Description
bakerId CCD_BakerId

The id of the primed validator.

account CCD_AccountAddress

The account of the primed validator.

CCD_BlockSpecialEvent_ValidatorSuspended

The id of a validator that got suspended due to too many missed rounds.

GRPC documentation: concordium.v2.BlockSpecialEvent.ValidatorSuspended

Attributes:

Name Type Description
bakerId CCD_BakerId

The id of the suspended validator.

account CCD_AccountAddress

The account of the suspended validator.

CCD_BlockTableSummary

Summary information about the block table in the node.

GRPC documentation: concordium.v2.BlockTableSummary

Attributes:

Name Type Description
dead_block_cache_size int

The size of the dead block cache. Note that inn the GRPC implementation, if the value equals the default value, it's not sent. Hence an Optional with default value of 0.

live_blocks list[CCD_BlockHash]

A list of live block hashes.

CCD_BlocksAtHeightResponse

Response for GetBlocksAtHeight containing the live blocks at a given height.

GRPC documentation: concordium.v2.BlocksAtHeightResponse

Attributes:

Name Type Description
blocks list[CCD_BlockHash]

Live blocks at the given height.

CCD_BranchBlocks

A list of blocks at a specific branch height.

GRPC documentation: concordium.v2.BranchBlocks

Attributes:

Name Type Description
blocks_at_branch_height list[CCD_BlockHash]

A list of block hashes at the branch height.

CCD_CapitalBound

A bound on the relative share of the total staked capital that a validator can have as its stake. This is required to be greater than 0.

GRPC documentation: concordium.v2.CapitalBound

Attributes:

Name Type Description
value CCD_AmountFraction

The fraction representing the capital bound.

CCD_ChainArData

Data relating to a single anonymity revoker sent by the account holder to the chain.

GRPC documentation: concordium.v2.ChainArData

Attributes:

Name Type Description
enc_id_cred_pub_share str

Share of the encryption of IdCredPub.

CCD_ChainParameters

Contains the chain parameters for a particular version of the protocol.

GRPC documentation: concordium.v2.ChainParameters

Attributes:

Name Type Description
v0 Optional[CCD_ChainParametersV0]

Chain parameters for protocol versions 1-3.

v1 Optional[CCD_ChainParametersV1]

Chain parameters for protocol version 4.

v2 Optional[CCD_ChainParametersV2]

Chain parameters for protocol versions 5-7.

v3 Optional[CCD_ChainParametersV3]

Chain parameters for protocol version 8 onwards.

CCD_ChainParametersV0

Chain parameters that apply in protocol versions 1-3.

GRPC documentation: concordium.v2.ChainParametersV0

Attributes:

Name Type Description
election_difficulty CCD_ElectionDifficulty

The election difficulty used for the validator lottery.

euro_per_energy CCD_ExchangeRate

Exchange rate of euro per energy unit.

micro_ccd_per_euro CCD_ExchangeRate

Exchange rate of micro CCD per euro.

baker_cooldown_epochs CCD_Epoch

Number of epochs a validator must cooldown when removing their stake.

account_creation_limit CCD_CredentialsPerBlockLimit

Maximum number of credentials that can be created per block.

mint_distribution CCD_MintDistributionCpv0

Parameters for the distribution of newly minted CCD.

transaction_fee_distribution CCD_TransactionFeeDistribution

Parameters for the distribution of transaction fees.

gas_rewards CCD_GasRewards

Parameters for the distribution of execution costs (gas).

foundation_account CCD_AccountAddress

The foundation account address.

minimum_threshold_for_baking microCCD

Minimum stake required to become a validator.

root_keys CCD_HigherLevelKeys

The root update keys.

level1_keys CCD_HigherLevelKeys

The level 1 update keys.

level2_keys CCD_AuthorizationsV0

The level 2 update keys and authorizations.

CCD_ChainParametersV1

Chain parameters that apply from protocol version 4 onwards.

GRPC documentation: concordium.v2.ChainParametersV1

Attributes:

Name Type Description
election_difficulty CCD_ElectionDifficulty

The election difficulty used for the validator lottery.

euro_per_energy CCD_ExchangeRate

Exchange rate of euro per energy unit.

micro_ccd_per_euro CCD_ExchangeRate

Exchange rate of micro CCD per euro.

cooldown_parameters CCD_CooldownParametersCpv1

Parameters related to cooldown periods.

time_parameters CCD_TimeParametersCpv1

Parameters related to time settings.

account_creation_limit CCD_CredentialsPerBlockLimit

Maximum number of credentials that can be created per block.

mint_distribution CCD_MintDistributionCpv1

Parameters for the distribution of newly minted CCD.

transaction_fee_distribution CCD_TransactionFeeDistribution

Parameters for the distribution of transaction fees.

gas_rewards CCD_GasRewards

Parameters for the distribution of execution costs (gas).

foundation_account CCD_AccountAddress

The foundation account address.

pool_parameters CCD_PoolParametersCpv1

Parameters related to staking pools.

root_keys CCD_HigherLevelKeys

The root update keys.

level1_keys CCD_HigherLevelKeys

The level 1 update keys.

level2_keys CCD_AuthorizationsV1

The level 2 update keys and authorizations.

CCD_ChainParametersV2

Chain parameters that apply from protocol version 6 onwards.

GRPC documentation: concordium.v2.ChainParametersV2

Attributes:

Name Type Description
consensus_parameters CCD_ConsensusParametersV1

Parameters controlling consensus from protocol version 6 onwards.

euro_per_energy CCD_ExchangeRate

Exchange rate of euro per energy unit.

micro_ccd_per_euro CCD_ExchangeRate

Exchange rate of micro CCD per euro.

cooldown_parameters CCD_CooldownParametersCpv1

Parameters related to cooldown periods.

time_parameters CCD_TimeParametersCpv1

Parameters related to time settings.

account_creation_limit CCD_CredentialsPerBlockLimit

Maximum number of credentials that can be created per block.

mint_distribution CCD_MintDistributionCpv1

Parameters for the distribution of newly minted CCD.

transaction_fee_distribution CCD_TransactionFeeDistribution

Parameters for the distribution of transaction fees.

gas_rewards CCD_GasRewardsV2

Parameters for the distribution of execution costs (gas).

foundation_account CCD_AccountAddress

The foundation account address.

pool_parameters CCD_PoolParametersCpv1

Parameters related to staking pools.

root_keys CCD_HigherLevelKeys

The root update keys.

level1_keys CCD_HigherLevelKeys

The level 1 update keys.

level2_keys CCD_AuthorizationsV1

The level 2 update keys and authorizations.

finalization_committee_parameters CCD_FinalizationCommitteeParameters

Parameters for the finalization committee.

CCD_ChainParametersV3

Chain parameters that apply from protocol version 8 onwards.

GRPC documentation: concordium.v2.ChainParametersV3

Attributes:

Name Type Description
consensus_parameters CCD_ConsensusParametersV1

Parameters controlling consensus from protocol version 6 onwards.

euro_per_energy CCD_ExchangeRate

Exchange rate of euro per energy unit.

micro_ccd_per_euro CCD_ExchangeRate

Exchange rate of micro CCD per euro.

cooldown_parameters CCD_CooldownParametersCpv1

Parameters related to cooldown periods.

time_parameters CCD_TimeParametersCpv1

Parameters related to time settings.

account_creation_limit CCD_CredentialsPerBlockLimit

Maximum number of credentials that can be created per block.

mint_distribution CCD_MintDistributionCpv1

Parameters for the distribution of newly minted CCD.

transaction_fee_distribution CCD_TransactionFeeDistribution

Parameters for the distribution of transaction fees.

gas_rewards CCD_GasRewardsV2

Parameters for the distribution of execution costs (gas).

foundation_account CCD_AccountAddress

The foundation account address.

pool_parameters CCD_PoolParametersCpv1

Parameters related to staking pools.

root_keys CCD_HigherLevelKeys

The root update keys.

level1_keys CCD_HigherLevelKeys

The level 1 update keys.

level2_keys CCD_AuthorizationsV1

The level 2 update keys and authorizations.

finalization_committee_parameters CCD_FinalizationCommitteeParameters

Parameters for the finalization committee.

validator_score_parameters CCD_ValidatorScoreParameters

Parameters for validator scoring.

CCD_CommissionRanges

Ranges of allowed commission values that pools may choose from.

GRPC documentation: concordium.v2.CommissionRanges

Attributes:

Name Type Description
finalization CCD_InclusiveRangeAmountFraction

The range of allowed finalization commissions.

baking CCD_InclusiveRangeAmountFraction

The range of allowed validator commissions.

transaction CCD_InclusiveRangeAmountFraction

The range of allowed transaction commissions.

CCD_CommissionRates

Distribution of rewards for a particular pool.

GRPC documentation: concordium.v2.CommissionRates

Attributes:

Name Type Description
baking float

Fraction of block production rewards charged by the pool owner.

finalization float

Fraction of finalization rewards charged by the pool owner.

transaction float

Fraction of transaction rewards charged by the pool owner.

CCD_ConsensusDetailedStatus

Detailed status of consensus at a particular point in time.

GRPC documentation: concordium.v2.ConsensusDetailedStatus

Attributes:

Name Type Description
genesis_block CCD_BlockHash

The hash of the genesis block.

persistent_round_status CCD_PersistentRoundStatus

The status of the persistent round.

round_status CCD_RoundStatus

The status of the current round.

non_finalized_transaction_count int

The count of non-finalized transactions. Note that in the GRPC implementation, if the value equals the default value, it's not sent. Hence an Optional with default value of 0.

transaction_table_purge_counter int

The counter for purging the transaction table. Note that in the GRPC implementation, if the value equals the default value, it's not sent. Hence an Optional with default value of 0.

block_table CCD_BlockTableSummary

Summary of the block table.

branches list[CCD_BranchBlocks]

List of branch blocks.

round_existing_blocks list[CCD_RoundExistingBlock]

List of existing blocks in the current round.

round_existing_qcs list[CCD_RoundExistingQC]

List of existing QCs in the current round.

genesis_block_height int

The height of the genesis block.

last_finalized_block CCD_BlockHash

The hash of the last finalized block.

last_finalized_block_height int

The height of the last finalized block.

latest_finalization_entry Optional[CCD_RawFinalizationEntry]

The latest finalization entry.

epoch_bakers CCD_EpochBakers

The epoch bakers.

timeout_messages Optional[CCD_TimeoutMessages]

The timeout messages.

terminal_block Optional[CCD_BlockHash]

The hash of the terminal block.

CCD_ConsensusDetailedStatusQuery

Query for detailed consensus status at a specific genesis index.

GRPC documentation: concordium.v2.ConsensusDetailedStatusQuery

Attributes:

Name Type Description
genesis_index Optional[int]

The genesis index for which to get the consensus status. If not provided, uses the current era.

CCD_ConsensusInfo

Contains the consensus information in a node.

GRPC documentation: concordium.v2.ConsensusInfo

Attributes:

Name Type Description
best_block CCD_BlockHash

Hash of the best/last block in the tree.

genesis_block CCD_BlockHash

Hash of the genesis block.

genesis_time CCD_TimeStamp

Time of the genesis block.

slot_duration Optional[CCD_Duration]

Duration of a slot (present in protocol versions < 6).

epoch_duration CCD_Duration

Duration of an epoch.

last_finalized_block CCD_BlockHash

Hash of the last finalized block.

best_block_height int

Block height of the best block.

last_finalized_block_height int

Block height of the last finalized block.

blocks_received_count int

Number of blocks received.

block_last_received_time Optional[CCD_TimeStamp]

Time the last block was received.

block_receive_latency_ema float

Exponential moving average of block receive latency.

block_receive_latency_emsd float

Exponential moving standard deviation of block receive latency.

block_receive_period_ema Optional[float]

Exponential moving average of block receive period.

block_receive_period_emsd Optional[float]

Exponential moving standard deviation of block receive period.

blocks_verified_count int

Number of blocks verified.

block_last_arrived_time Optional[CCD_TimeStamp]

Time the last block arrived.

block_arrive_latency_ema float

Exponential moving average of block arrive latency.

block_arrive_latency_emsd float

Exponential moving standard deviation of block arrive latency.

block_arrive_period_ema Optional[float]

Exponential moving average of block arrive period.

block_arrive_period_emsd Optional[float]

Exponential moving standard deviation of block arrive period.

transactions_per_block_ema float

Exponential moving average of transactions per block.

transactions_per_block_emsd float

Exponential moving standard deviation of transactions per block.

finalization_count int

Number of finalized blocks.

last_finalized_time Optional[CCD_TimeStamp]

Time of last finalization.

finalization_period_ema Optional[float]

Exponential moving average of finalization period.

finalization_period_emsd Optional[float]

Exponential moving standard deviation of finalization period.

protocol_version str

Protocol version.

genesis_index int

Index of the genesis block.

current_era_genesis_block CCD_BlockHash

Hash of the genesis block of the current era.

current_era_genesis_time CCD_TimeStamp

Time of the genesis block of the current era.

current_timeout_duration Optional[CCD_Duration]

Current timeout duration in consensus.

current_round Optional[CCD_Round]

Current round in consensus.

current_epoch Optional[int]

Current epoch in consensus.

trigger_block_time Optional[CCD_TimeStamp]

Time when the trigger block was received.

CCD_ConsensusParametersV1

Parameters controlling consensus from protocol version 6 onwards.

GRPC documentation: concordium.v2.ConsensusParametersV1

Attributes:

Name Type Description
timeout_parameters CCD_TimeOutParameters

Parameters controlling consensus timeouts.

min_block_time CCD_Duration

Minimum time between blocks.

block_energy_limit CCD_Energy

Maximum amount of energy that can be used in a block.

CCD_ContractAddress

Address of a smart contract instance.

GRPC documentation: concordium.v2.ContractAddress

Attributes:

Name Type Description
index uint64

The index of the smart contract.

subindex uint64

The subindex of the smart contract instance. Currently not used, so it is always 0.

Methods:

Name Description
from_index

Create a CCD_ContractAddress instance from the given index and subindex.

from_str

Parses a string representation of a CCD contract address and returns a CCD_ContractAddress object.

from_index(index, subindex) classmethod

Create a CCD_ContractAddress instance from the given index and subindex.

Parameters:

Name Type Description Default
index int

The index value for the contract address.

required
subindex int

The subindex value for the contract address.

required

Returns:

Name Type Description
CCD_ContractAddress CCD_ContractAddress

An instance of CCD_ContractAddress initialized with the provided index and subindex.

from_str(str_repr) classmethod

Parses a string representation of a CCD contract address and returns a CCD_ContractAddress object. Args: str_repr (str): The string representation of the CCD contract address in the format "". Returns: CCD_ContractAddress: An object representing the parsed contract address. Raises: ValueError: If the string representation is not in the expected format.

CCD_ContractInitializedEvent

Data generated as part of initializing a single contract instance.

GRPC documentation: concordium.v2.ContractInitializedEvent

Attributes:

Name Type Description
contract_version int

Contract version.

origin_ref CCD_ModuleRef

Module with the source code of the contract.

address CCD_ContractAddress

The newly assigned address of the contract.

amount microCCD

The amount the instance was initialized with.

init_name str

The name of the contract.

events list[CCD_ContractEvent]

Any contract events that might have been generated by the contract initialization.

parameter CCD_Parameter

The parameter passed to the initializer.

CCD_ContractTraceElement

A trace element for a contract execution. Recording what happened during the execution.

GRPC documentation: concordium.v2.ContractTraceElement

Attributes:

Name Type Description
updated Optional[CCD_InstanceUpdatedEvent]

A contract was updated.

transferred Optional[CCD_ContractTraceElement_Transferred]

A contract transferred an amount to an account.

interrupted Optional[CCD_ContractTraceElement_Interrupted]

A contract was interrupted.

resumed Optional[CCD_ContractTraceElement_Resumed]

A previously interrupted contract was resumed.

upgraded Optional[CCD_ContractTraceElement_Upgraded]

A contract was upgraded from one module to another.

CCD_ContractTraceElement_Interrupted

A contract was interrupted. This occurs when a contract invokes another contract or makes a transfer to an account.

GRPC documentation: concordium.v2.ContractTraceElement.Interrupted

Attributes:

Name Type Description
address CCD_ContractAddress

The contract that was interrupted.

events list[CCD_ContractEvent]

The events generated up until the interruption.

CCD_ContractTraceElement_Resumed

A previously interrupted contract was resumed.

GRPC documentation: concordium.v2.ContractTraceElement.Resumed

Attributes:

Name Type Description
address CCD_ContractAddress

The address of the resumed contract.

success bool

Whether the execution was successful.

CCD_ContractTraceElement_Transferred

A contract transferred an amount to an account.

GRPC documentation: concordium.v2.ContractTraceElement.Transferred

Attributes:

Name Type Description
sender CCD_ContractAddress

The contract that sent the amount.

amount microCCD

The amount that was transferred.

receiver CCD_AccountAddress

The account that received the amount.

CCD_ContractTraceElement_Upgraded

A contract was upgraded from one module to another.

GRPC documentation: concordium.v2.ContractTraceElement.Upgraded

Attributes:

Name Type Description
address CCD_ContractAddress

The contract that was upgraded.

from_module CCD_ModuleRef

The original module reference.

to_module CCD_ModuleRef

The new module reference.

CCD_ContractUpdateIssued

The effects of executing a smart contract update transaction. Note that this will always be generated with at least one element in the effects list. If the execution failed the first element will be an interrupted message.

GRPC documentation: concordium.v2.ContractUpdateIssued

Attributes:

Name Type Description
effects list[CCD_ContractTraceElement]

The effects of executing the contract update.

CCD_Cooldown

The stake on the account that is in cooldown. When stake is removed from a validator or delegator (from protocol version 7) it first enters the pre-pre-cooldown state. The next time the stake snapshot is taken (at the epoch transition before a payday) it enters the pre-cooldown state. At the subsequent payday, it enters the cooldown state. At the payday after the end of the cooldown period, the stake is finally released.

GRPC documentation: concordium.v2.Cooldown

Attributes:

Name Type Description
end_time CCD_TimeStamp

The time in milliseconds since the Unix epoch when the cooldown period ends.

amount microCCD

The amount that is in cooldown and set to be released at the end of the cooldown period.

status CoolDownStatus

The status of the cooldown (0=COOLDOWN, 1=PRE_COOLDOWN, 2=PRE_PRE_COOLDOWN).

CCD_CooldownParametersCpv1

Parameters related to cooldown periods for pool owners and delegators.

GRPC documentation: concordium.v2.CooldownParametersCpv1

Attributes:

Name Type Description
pool_owner_cooldown CCD_DurationSeconds

Number of seconds that pool owners must cooldown when reducing their equity capital or closing the pool.

delegator_cooldown CCD_DurationSeconds

Number of seconds that a delegator must cooldown when reducing their delegated stake.

CCD_CredentialCommitments

Commitments that are part of a normal credential.

GRPC documentation: concordium.v2.CredentialCommitments

Attributes:

Name Type Description
prf CCD_Commitment

Commitment to the PRF key.

cred_counter CCD_Commitment

Commitment to the counter used to generate the credential registration id.

max_accounts CCD_Commitment

Commitment to the max_accounts value, which determines the maximum number of credentials that may be created from the identity object.

attributes dict[int, CCD_Commitment]

Commitments to the attributes which have not been revealed in the policy.

id_cred_sec_sharing_coeff list[CCD_Commitment]

List of commitments to the coefficients of the sharing polynomial. This polynomial is used in a shared encryption of id_cred_pub among the anonymity revokers.

CCD_CredentialCommitments_AttributesEntry

A map entry in CredentialCommitments.attributes, containing commitments to attributes which have not been revealed in the policy.

GRPC documentation: concordium.v2.CredentialCommitments

Attributes:

Name Type Description
key int

The attribute tag.

value CCD_Commitment

The commitment to the attribute.

CCD_CredentialPublicKeys

Public keys of a single credential.

GRPC documentation: concordium.v2.CredentialPublicKeys

Attributes:

Name Type Description
keys dict[int, CCD_AccountVerifyKey]

Map of key indexes to account verification keys.

threshold CCD_SignatureThreshold

The number of signatures required to sign.

CCD_CredentialType

The type of credential. Initial credentials have a special status, while normal credentials are subject to additional verification.

GRPC documentation: concordium.v2.CredentialType

Attributes:

Name Type Description
initial int

Initial credentials have a special status.

normal int

Normal credentials are subject to additional verification.

CCD_CurrentPaydayStatus

Information about a validator's stake, rewards and status for the current reward period.

GRPC documentation: concordium.v2.CurrentPaydayStatus

Attributes:

Name Type Description
baker_equity_capital microCCD

The equity capital provided by the pool owner.

blocks_baked int

The number of blocks baked in the current reward period.

delegated_capital microCCD

The capital delegated to the pool by other accounts.

effective_stake microCCD

The effective stake of the pool, computed according to the leverage bound.

finalization_live bool

Whether the validator participates in finalization.

lottery_power float

The pool's relative probability of being selected as validator.

transaction_fees_earned microCCD

Transaction fees earned in the current reward period.

is_primed_for_suspension Optional[bool]

Whether the validator is primed for suspension.

missed_rounds Optional[int]

Number of rounds missed by the validator.

CCD_DelegationConfigured

An account configured delegation. The details of what happened are contained in the list of DelegationEvents.

GRPC documentation: concordium.v2.AccountTransactionEffects.DelegationConfigured

Attributes:

Name Type Description
events list[CCD_DelegationEvent]

The delegation events that occurred during configuration.

CCD_DelegationEvent

Events that may result from configuring delegation.

GRPC documentation: concordium.v2.DelegationEvent

Attributes:

Name Type Description
delegation_stake_increased Optional[CCD_DelegationStakeIncreased]

The delegator's stake increased.

delegation_stake_decreased Optional[CCD_DelegationStakeDecreased]

The delegator's stake decreased.

delegation_set_restake_earnings Optional[CCD_DelegationSetRestakeEarnings]

The delegator's restaking setting was updated.

delegation_set_delegation_target Optional[CCD_DelegationSetDelegationTarget]

The delegator's delegation target was updated.

delegation_added Optional[CCD_DelegatorId]

A delegator was added.

delegation_removed Optional[CCD_DelegatorId]

A delegator was removed.

baker_removed Optional[CCD_BakerRemoved]

An existing validator was removed.

CCD_DelegationSetDelegationTarget

The delegator's delegation target was updated.

GRPC documentation: concordium.v2.DelegationEvent.DelegationSetDelegationTarget

Attributes:

Name Type Description
delegator_id CCD_DelegatorId

Delegator's id.

delegation_target CCD_DelegationTarget

New delegation target.

CCD_DelegationSetRestakeEarnings

The delegator's restaking setting was updated.

GRPC documentation: concordium.v2.DelegationEvent.DelegationSetRestakeEarnings

Attributes:

Name Type Description
delegator_id CCD_DelegatorId

Delegator's id.

restake_earnings bool

Whether earnings will be restaked.

CCD_DelegationStakeDecreased

The delegator's stake decreased.

GRPC documentation: concordium.v2.DelegationEvent.DelegationStakeDecreased

Attributes:

Name Type Description
delegator_id CCD_DelegatorId

Delegator's id.

new_stake microCCD

New stake.

CCD_DelegationStakeIncreased

The delegator's stake increased.

GRPC documentation: concordium.v2.DelegationEvent.DelegationStakeIncreased

Attributes:

Name Type Description
delegator_id CCD_DelegatorId

Delegator's id.

new_stake microCCD

New stake.

CCD_DelegationTarget

Entity to which the account delegates a portion of its stake.

GRPC documentation: concordium.v2.DelegationTarget

Attributes:

Name Type Description
passive_delegation Optional[bool]

Delegate passively, i.e., to no specific validator.

validator Optional[CCD_BakerId]

Delegate to a specific validator.

CCD_DelegatorInfo

Information about a delegator for the current reward period.

GRPC documentation: concordium.v2.DelegatorInfo

Attributes:

Name Type Description
account CCD_AccountAddress

The delegator account address.

stake microCCD

The amount of stake currently staked to the pool.

pending_change Optional[CCD_StakePendingChange]

Any pending changes to the stake.

CCD_DelegatorRewardPeriodInfo

Information about a delegator for the current reward period.

GRPC documentation: concordium.v2.DelegatorRewardPeriodInfo

Attributes:

Name Type Description
account CCD_AccountAddress

The delegator account address.

stake microCCD

The amount of stake currently staked to the pool.

CCD_Description

Description either of an anonymity revoker or identity provider. Metadata that should be visible on the chain.

GRPC documentation: concordium.v2.Description

Attributes:

Name Type Description
name str

The name.

url str

A link to more information about the anonymity revoker or identity provider.

description str

A free form description of the revoker or provider.

CCD_ElectionInfo

Contains information related to validator election for a particular block.

GRPC documentation: concordium.v2.ElectionInfo

Attributes:

Name Type Description
election_difficulty Optional[CCD_ElectionDifficulty]

Baking lottery election difficulty. Present only in protocol versions 1-5.

election_nonce CCD_LeadershipElectionNonce

Current leadership election nonce for the lottery.

baker_election_info list[CCD_ElectionInfo_Baker]

List of the currently eligible bakers.

CCD_ElectionInfo_Baker

Information about an individual validator's lottery power.

GRPC documentation: concordium.v2.ElectionInfo.Validator

Attributes:

Name Type Description
validator CCD_BakerId

The ID of the validator.

account CCD_AccountAddress

The account address of the validator.

lottery_power float

The lottery power of the validator, rounded to the nearest representable "double".

CCD_EncryptedAmountRemovedEvent

Event generated when one or more encrypted amounts are consumed from the account.

GRPC documentation: concordium.v2.EncryptedAmountRemovedEvent

Attributes:

Name Type Description
account CCD_AccountAddress

The affected account.

new_amount CCD_EncryptedAmount

The new self encrypted amount on the affected account.

input_amount CCD_EncryptedAmount

The input encrypted amount that was removed.

up_to_index int

The index indicating which amounts were used.

CCD_EncryptedBalance

The encrypted balance of a CCD account.

GRPC documentation: concordium.v2.EncryptedBalance

Attributes:

Name Type Description
self_amount CCD_EncryptedAmount

Encrypted amount that is a result of this account's actions. In particular this list includes the aggregate of remaining amounts from transfers to public balance, transfers to other accounts, and encrypted amounts transferred from public balance.

start_index int

Starting index for incoming encrypted amounts. If an aggregated amount is present then this index is associated with such an amount and the list of incoming encrypted amounts starts at index start_index + 1.

aggregated_amount Optional[CCD_EncryptedAmount]

If present, the amount that has resulted from aggregating other amounts.

num_aggregated Optional[int]

The number of aggregated amounts (must be at least 2 if present). Present if and only if aggregated_amount is present.

incoming_amounts list[CCD_EncryptedAmount]

Amounts starting at start_index (or at start_index + 1 if there is an aggregated amount present). They are assumed to be numbered sequentially. The length of this list is bounded by the maximum number of incoming amounts on the accounts, which is currently 32.

CCD_EncryptedSelfAmountAddedEvent

Event generated when an account adds a self amount from public balance to encrypted balance.

GRPC documentation: concordium.v2.EncryptedSelfAmountAddedEvent

Attributes:

Name Type Description
account CCD_AccountAddress

The affected account.

new_amount CCD_EncryptedAmount

The new encrypted amount on the affected account.

amount microCCD

The amount that was encrypted.

CCD_EpochBakers

The bakers and finalizers for different epochs.

GRPC documentation: concordium.v2.EpochBakers

Attributes:

Name Type Description
previous_epoch_bakers CCD_BakersAndFinalizers

Bakers and finalizers for the previous epoch.

current_epoch_bakers Optional[CCD_BakersAndFinalizers]

Bakers and finalizers for the current epoch.

next_epoch_bakers Optional[CCD_BakersAndFinalizers]

Bakers and finalizers for the next epoch.

next_payday CCD_Epoch

The next payday epoch.

CCD_ExchangeRate

Represents an exchange rate. Value is numerator/denominator.

GRPC documentation: concordium.v2.ExchangeRate

Attributes:

Name Type Description
value CCD_Ratio

The ratio representing the exchange rate.

CCD_FinalizationCommitteeParameters

Finalization committee parameters used from protocol version 6.

GRPC documentation: concordium.v2.FinalizationCommitteeParameters

Attributes:

Name Type Description
minimum_finalizers uint32

The minimum size of a finalization committee before finalizer_relative_stake_threshold takes effect.

maximum_finalizers uint32

The maximum size of a finalization committee.

finalizer_relative_stake_threshold CCD_AmountFraction

The threshold for determining the stake required for being eligible for the finalization committee. The amount is given by total stake in pools * finalizer_relative_stake_threshold.

CCD_FinalizedBlockInfo

Information about a finalized block that is part of the streaming response.

GRPC documentation: concordium.v2.FinalizedBlockInfo

Attributes:

Name Type Description
hash CCD_BlockHash

Hash of the block.

height int

Absolute height of the block, height 0 is the genesis block.

CCD_FullBakerInfo

Full information about a validator, including identity and keys.

GRPC documentation: concordium.v2.FullBakerInfo

Attributes:

Name Type Description
baker_identity Optional[CCD_BakerId]

The identity of the validator.

election_verify_key CCD_BakerElectionVerifyKey

The election verification key of the validator.

signature_verify_key CCD_BakerSignatureVerifyKey

The signature verification key of the validator.

aggregation_verify_key CCD_BakerAggregationVerifyKey

The aggregation verification key of the validator.

stake microCCD

The stake of the validator in microCCD.

CCD_GasRewards

Distribution of gas rewards for chain parameters version 0 and 1.

GRPC documentation: concordium.v2.GasRewards

Attributes:

Name Type Description
validator CCD_AmountFraction

The fraction paid to the validator.

finalization_proof CCD_AmountFraction

Fraction paid for including a finalization proof in a block.

account_creation CCD_AmountFraction

Fraction paid for including each account creation transaction in a block.

chain_update CCD_AmountFraction

Fraction paid for including an update transaction in a block.

CCD_GasRewardsV2

Distribution of gas rewards for chain parameters version 6 and onwards.

GRPC documentation: concordium.v2.GasRewardsV2

Attributes:

Name Type Description
validator CCD_AmountFraction

The fraction paid to the validator.

account_creation CCD_AmountFraction

Fraction paid for including each account creation transaction in a block.

chain_update CCD_AmountFraction

Fraction paid for including an update transaction in a block.

CCD_GovernanceAccount

NOT mirrored to an official class.Represents a governance account in the blockchain.

CCD_HigherLevelKeys

Represents root or level 1 keys.

GRPC documentation: concordium.v2.HigherLevelKeys

Attributes:

Name Type Description
keys list[CCD_UpdatePublicKey]

The keys.

threshold CCD_UpdateKeysThreshold

The number of keys needed to make a chain update.

CCD_InclusiveRangeAmountFraction

Inclusive range of amount fractions.

GRPC documentation: concordium.v2.InclusiveRangeAmountFraction

Attributes:

Name Type Description
min CCD_AmountFraction

The minimum value of the range.

max_ CCD_AmountFraction

The maximum value of the range.

CCD_InitialCredentialValues

Values contained in an initial credential.

GRPC documentation: concordium.v2.InitialCredentialValues

Attributes:

Name Type Description
keys CCD_CredentialPublicKeys

Public keys of the credential.

cred_id CCD_CredentialRegistrationId

Its registration ID.

ip_id CCD_IdentityProviderIdentity

The identity provider who signed the identity object from which this credential is derived.

policy CCD_Policy

Policy of this credential.

CCD_InitializationParameters

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_InstanceInfo

Information about a smart contract instance.

GRPC documentation: concordium.v2.InstanceInfo

Attributes:

Name Type Description
v0 Optional[CCD_InstanceInfo_V0]

Version 0 smart contract instance information.

v1 Optional[CCD_InstanceInfo_V1]

Version 1 smart contract instance information.

CCD_InstanceInfo_V0

Version 0 smart contract instance information.

GRPC documentation: concordium.v2.InstanceInfo.V0

Attributes:

Name Type Description
model CCD_ContractStateV0

The state of the instance.

owner CCD_AccountAddress

The account address which deployed the instance.

amount microCCD

The amount of CCD tokens in the balance of the instance.

methods list[CCD_ReceiveName]

A list of endpoints exposed by the instance.

name CCD_InitName

The name of the smart contract of the instance.

source_module CCD_ModuleRef

The module reference for the smart contract module of the instance.

CCD_InstanceInfo_V1

Version 1 smart contract instance information.

GRPC documentation: concordium.v2.InstanceInfo.V1

Attributes:

Name Type Description
owner CCD_AccountAddress

The account address which deployed the instance.

amount microCCD

The amount of CCD tokens in the balance of the instance.

methods list[CCD_ReceiveName]

A list of endpoints exposed by the instance.

name CCD_InitName

The name of the smart contract of the instance.

source_module CCD_ModuleRef

The module reference for the smart contract module of the instance.

CCD_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.

GRPC documentation: concordium.v2.InstanceUpdatedEvent

Attributes:

Name Type Description
contract_version int

Contract version.

address CCD_ContractAddress

Address of the affected instance.

instigator CCD_Address

The origin of the message to the smart contract. This can be either an account or a smart contract.

amount microCCD

The amount the method was invoked with.

parameter CCD_Parameter

The parameter passed to the method.

receive_name CCD_ReceiveName

The name of the method that was executed.

events Optional[list[CCD_ContractEvent]]

Any contract events that might have been generated by the contract execution.

CCD_InvokeInstanceResponse

Response from invoking a smart contract instance. Contains either success or failure information.

GRPC documentation: concordium.v2.InvokeInstanceResponse

Attributes:

Name Type Description
success Optional[CCD_InvokeInstanceResponse_Success]

Details of a successful invocation.

failure Optional[CCD_InvokeInstanceResponse_Failure]

Details of a failed invocation.

CCD_InvokeInstanceResponse_Failure

Failure response when invoking a smart contract instance.

GRPC documentation: concordium.v2.InvokeInstanceResponse.Failure

Attributes:

Name Type Description
return_value bytes

The return value from the failed contract execution.

used_energy CCD_Energy

The amount of energy used during execution.

reason CCD_RejectReason

The reason why the execution failed.

CCD_InvokeInstanceResponse_Success

Success response when invoking a smart contract instance.

GRPC documentation: concordium.v2.InvokeInstanceResponse.Success

Attributes:

Name Type Description
return_value bytes

The return value from the contract execution.

used_energy CCD_Energy

The amount of energy used during execution.

effects list[CCD_ContractTraceElement]

List of effects produced by the execution.

CCD_IpInfo

Public information about an identity provider.

GRPC documentation: concordium.v2.IpInfo

Attributes:

Name Type Description
identity CCD_IpIdentity

Unique identifier of the identity provider.

description CCD_Description

Description of the identity provider.

verify_key CCD_IpVerifyKey

Pointcheval-Sanders public key of the identity provider.

cdi_verify_key CCD_IpCdiVerifyKey

Ed25519 public key of the identity provider.

CCD_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.

GRPC documentation: concordium.v2.Level1Update

Attributes:

Name Type Description
level_1_keys_update Optional[CCD_HigherLevelKeys]

The level 1 keys were updated.

level_2_keys_update_v0 Optional[CCD_AuthorizationsV0]

The level 2 keys were updated.

level_2_keys_update_v1 Optional[CCD_AuthorizationsV1]

The level 2 keys were updated. This is similar to level_2_keys_update_v0 except that a few more keys can be updated.

CCD_LeverageFactor

A leverage factor.

GRPC documentation: concordium.v2.LeverageFactor

Attributes:

Name Type Description
value CCD_Ratio

The ratio representing the leverage factor.

CCD_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.

GRPC documentation: concordium.v2.MintDistributionCpv0

Attributes:

Name Type Description
mint_per_slot CCD_MintRate

Mint rate per slot.

baking_reward CCD_AmountFraction

The fraction of newly created CCD allocated to validator rewards.

finalization_reward CCD_AmountFraction

The fraction of newly created CCD allocated to finalization rewards.

CCD_MintDistributionCpv1

Distribution of mint rewards for protocol version 4 and onwards.

GRPC documentation: concordium.v2.MintDistributionCpv1

Attributes:

Name Type Description
baking_reward AmountFraction

The fraction of newly created CCD allocated to validator rewards.

finalization_reward AmountFraction

The fraction of newly created CCD allocated to finalization rewards.

CCD_MintRate

A minting rate of CCD. The value is mantissa * 10^(-exponent).

GRPC documentation: concordium.v2.MintRate

Attributes:

Name Type Description
mantissa int

The mantissa part of the mint rate.

exponent int

The exponent part of the mint rate. This will never exceed 255 and can thus be stored in a single byte.

CCD_ModuleAccountState

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_ModuleState

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_NewEncryptedAmountEvent

Event generated when a new self encrypted amount is added to an account.

GRPC documentation: concordium.v2.NewEncryptedAmountEvent

Attributes:

Name Type Description
receiver CCD_AccountAddress

The affected account.

new_index int

The index at which this amount was added.

encrypted_amount CCD_EncryptedAmount

The encrypted amount that was added.

CCD_NewRelease

A new individual release. Part of a single transfer with schedule transaction.

GRPC documentation: concordium.v2.NewRelease

Attributes:

Name Type Description
timestamp CCD_TimeStamp

Effective time of the release in milliseconds since unix epoch.

amount microCCD

Amount to be released.

CCD_NextUpdateSequenceNumbers

The sequence numbers that will be used for the next updates of each kind.

GRPC documentation: concordium.v2.NextUpdateSequenceNumbers

Attributes:

Name Type Description
root_keys Optional[CCD_SequenceNumber]

Next sequence number for root keys updates.

level1_keys Optional[CCD_SequenceNumber]

Next sequence number for level 1 keys updates.

level2_keys Optional[CCD_SequenceNumber]

Next sequence number for level 2 keys updates.

protocol Optional[CCD_SequenceNumber]

Next sequence number for protocol updates.

election_difficulty Optional[CCD_SequenceNumber]

Next sequence number for election difficulty updates.

euro_per_energy Optional[CCD_SequenceNumber]

Next sequence number for euro per energy rate updates.

micro_ccd_per_euro Optional[CCD_SequenceNumber]

Next sequence number for microCCD per euro rate updates.

foundation_account Optional[CCD_SequenceNumber]

Next sequence number for foundation account updates.

mint_distribution Optional[CCD_SequenceNumber]

Next sequence number for mint distribution updates.

transaction_fee_distribution Optional[CCD_SequenceNumber]

Next sequence number for transaction fee distribution updates.

gas_rewards Optional[CCD_SequenceNumber]

Next sequence number for gas rewards updates.

pool_parameters Optional[CCD_SequenceNumber]

Next sequence number for pool parameters updates.

add_anonymity_revoker Optional[CCD_SequenceNumber]

Next sequence number for adding anonymity revokers.

add_identity_provider Optional[CCD_SequenceNumber]

Next sequence number for adding identity providers.

cooldown_parameters Optional[CCD_SequenceNumber]

Next sequence number for cooldown parameters updates.

time_parameters Optional[CCD_SequenceNumber]

Next sequence number for time parameters updates.

timeout_parameters Optional[CCD_SequenceNumber]

Next sequence number for timeout parameters updates.

min_block_time Optional[CCD_SequenceNumber]

Next sequence number for minimum block time updates.

block_energy_limit Optional[CCD_SequenceNumber]

Next sequence number for block energy limit updates.

finalization_committee_parameters Optional[CCD_SequenceNumber]

Next sequence number for finalization committee parameter updates.

validator_score_parameters Optional[CCD_SequenceNumber]

Next sequence number for validator score parameter updates.

CCD_NormalCredentialValues

Values contained in a normal (non-initial) credential.

GRPC documentation: concordium.v2.NormalCredentialValues

Attributes:

Name Type Description
keys CCD_CredentialPublicKeys

Public keys of the credential.

cred_id CCD_CredentialRegistrationId

Its registration ID.

ip_id CCD_IdentityProviderIdentity

The identity provider who signed the identity object from which this credential is derived.

policy CCD_Policy

Policy of this credential.

ar_threshold ArThreshold

The number of anonymity revokers that must work together to revoke the anonymity of the credential holder.

ar_data dict[int, CCD_ChainArData]

Mapping from anonymity revoker identities to revocation data for the given anonymity revoker.

commitments CCD_CredentialCommitments

Commitments to attributes which have not been revealed.

CCD_OpenStatusTranslation

Enum representing the open status of a resource.

Attributes:

Name Type Description
open_for_all int

The resource is open for all users.

closed_for_new int

The resource is closed for new users but open for existing users.

closed_for_all int

The resource is closed for all users.

CCD_PassiveDelegationInfo

Information about the passive delegation pool.

GRPC documentation: concordium.v2.PassiveDelegationInfo

Attributes:

Name Type Description
all_pool_total_capital microCCD

Total capital staked across all pools, including passive delegation.

delegated_capital microCCD

The total amount delegated to passive delegation.

current_payday_transaction_fees_earned microCCD

Transaction fees earned in the current reward period.

current_payday_delegated_capital microCCD

The delegated capital in the current reward period.

commission_rates CCD_CommissionRates

The commission rates charged by the passive delegation pool.

CCD_PendingUpdate

A pending update.

GRPC documentation: concordium.v2.PendingUpdate

Attributes:

Name Type Description
effective_time TransactionTime

The effective time of the update.

root_keys Optional[CCD_HigherLevelKeys]

Updates to the root keys.

level1_keys Optional[CCD_HigherLevelKeys]

Updates to the level 1 keys.

level2_keys_cpv_0 Optional[CCD_AuthorizationsV0]

Updates to the level 2 keys.

level2_keys_cpv_1 Optional[CCD_AuthorizationsV1]

Updates to the level 2 keys.

protocol Optional[CCD_ProtocolUpdate]

Protocol updates.

election_difficulty Optional[CCD_ElectionDifficulty]

Updates to the election difficulty parameter.

euro_per_energy Optional[CCD_ExchangeRate]

Updates to the euro:energy exchange rate.

micro_ccd_per_euro Optional[CCD_ExchangeRate]

Updates to the CCD:EUR exchange rate.

foundation_account Optional[CCD_AccountAddress]

Updates to the foundation account.

mint_distribution_cpv_0 Optional[CCD_MintDistributionCpv0]

Updates to the mint distribution (prior to protocol version 4).

mint_distribution_cpv_1 Optional[CCD_MintDistributionCpv1]

Updates to the mint distribution (protocol version 4+).

transaction_fee_distribution Optional[CCD_TransactionFeeDistribution]

Updates to the transaction fee distribution.

gas_rewards Optional[CCD_GasRewards]

Updates to the GAS rewards.

pool_parameters_cpv_0 Optional[CCD_BakerStakeThreshold]

Updates validator stake threshold (prior to protocol version 4).

pool_parameters_cpv_1 Optional[CCD_PoolParametersCpv1]

Updates pool parameters (protocol version 4+).

add_anonymity_revoker Optional[CCD_ArInfo]

Adds a new anonymity revoker.

add_identity_provider Optional[CCD_IpInfo]

Adds a new identity provider.

cooldown_parameters Optional[CCD_CooldownParametersCpv1]

Updates to cooldown parameters for chain parameters.

time_parameters Optional[CCD_TimeParametersCpv1]

Updates to time parameters.

gas_rewards_cpv_2 Optional[CCD_GasRewardsCpv2]

Updates to the GAS rewards (protocol version 6+).

timeout_parameters Optional[CCD_TimeoutParameters]

Updates to the consensus timeouts.

min_block_time Optional[CCD_Duration]

Updates to the minimum time between blocks.

block_energy_limit Optional[CCD_Energy]

Updates to the block energy limit.

finalization_committee_parameters Optional[CCD_FinalizationCommitteeParameters]

Updates to the finalization committee.

validator_score_parameters Optional[CCD_ValidatorScoreParameters]

Updates to the validator score parameters.

CCD_PersistentRoundStatus

Persistent status of a consensus round that is stored to disk.

GRPC documentation: concordium.v2.PersistentRoundStatus

Attributes:

Name Type Description
last_signed_quorum_message Optional[CCD_QuorumMessage]

The last signed quorum message.

last_signed_timeout_message Optional[CCD_TimeoutMessage]

The last signed timeout message.

last_baked_round CCD_Round

The last round in which this node baked a block. Note that in the GRPC implementation, if the value equals the default value, it's not sent. Hence an Optional with default value of False.

latest_timeout Optional[CCD_RawTimeoutCertificate]

The latest timeout certificate.

CCD_Policy

Policy on a credential.

GRPC documentation: concordium.v2.Policy

Attributes:

Name Type Description
created_at CCD_YearMonth

The year and month when the identity object from which the credential is derived was created.

valid_to CCD_YearMonth

The last year and month when the credential is still valid. After this expires an account can no longer be created from the credential.

attributes dict[str, CCD_Policy_Attributes]

Mapping from attribute tags to attribute values. Attribute tags are always representable in a single u8, attribute values are never more than 31 bytes in length.

CCD_PoolInfo

Type for the response of GetPoolInfo. Contains information about a given pool at the end of a given block.

GRPC documentation: concordium.v2.PoolInfo

Attributes:

Name Type Description
all_pool_total_capital microCCD

Total capital staked across all pools, including passive delegation.

address CCD_AccountAddress

The account address of the pool owner.

equity_capital Optional[microCCD]

The equity capital provided by the pool owner. Absent if the pool is removed.

validator CCD_BakerId

The validator ID of the pool owner.

equity_pending_change Optional[CCD_BakerStakePendingChange]

Any pending changes to the equity capital of the pool.

current_payday_info Optional[CCD_CurrentPaydayStatus]

Information of the pool in the current reward period.

delegated_capital Optional[microCCD]

The capital delegated to the pool by other accounts. Absent if the pool is removed.

delegated_capital_cap Optional[microCCD]

The maximum amount that may be delegated to the pool. Absent if the pool is removed.

pool_info Optional[CCD_BakerPoolInfo]

The pool info associated with the pool. Absent if the pool is removed.

is_suspended Optional[bool]

Whether the pool is suspended.

CCD_PoolParametersCpv1

Parameters related to staking pools.

GRPC documentation: concordium.v2.PoolParametersCpv1

Attributes:

Name Type Description
passive_finalization_commission AmountFraction

Fraction of finalization rewards charged by the passive delegation.

passive_baking_commission AmountFraction

Fraction of block production rewards charged by the passive delegation.

passive_transaction_commission AmountFraction

Fraction of transaction rewards charged by the L-pool.

commission_bounds CCD_CommissionRanges

Bounds on the commission rates that may be charged by bakers.

minimum_equity_capital microCCD

Minimum equity capital required for a new validator.

capital_bound CCD_CapitalBound

Maximum fraction of the total staked capital that a new validator can have.

leverage_bound CCD_LeverageFactor

The maximum leverage that a validator can have as a ratio of total stake to equity capital.

CCD_ProtocolUpdate

A protocol update.

GRPC documentation: concordium.v2.ProtocolUpdate

Attributes:

Name Type Description
message_ str

A brief message about the update.

specification_url str

A URL of a document describing the update.

specificationHash CCD_Sha256Hash

SHA256 hash of the specification document.

specification_auxiliary_data bytes

Auxiliary data whose interpretation is defined by the new specification.

CCD_QuorumMessage

A message in the consensus quorum carrying finalization information.

GRPC documentation: concordium.v2.QuorumMessage

Attributes:

Name Type Description
signature CCD_QuorumSignature

The signature of the quorum message.

block CCD_BlockHash

The hash of the block associated with the quorum message.

finalizer CCD_FinalizerIndex

The index of the finalizer who created this message.

round CCD_Round

The round number of consensus.

epoch CCD_Epoch

The epoch number in consensus.

CCD_QuorumMessages

A collection of quorum messages and aggregated signatures in the consensus protocol.

GRPC documentation: concordium.v2.QuorumMessages

Attributes:

Name Type Description
quorum_messages list[CCD_QuorumMessage]

A list of quorum messages from individual finalizers.

aggregated_signatures list[CCD_AggregatedSignatures]

A list of aggregated signatures from sets of finalizers.

CCD_Ratio

Represents a ratio, i.e., 'numerator / denominator'.

GRPC documentation: concordium.v2.Ratio

Attributes:

Name Type Description
numerator int

The numerator.

denominator int

The denominator.

CCD_RawFinalizationEntry

A raw finalization entry in the consensus protocol.

GRPC documentation: concordium.v2.RawFinalizationEntry

Attributes:

Name Type Description
finalized_qc CCD_RawQuorumCertificate

The certificate that proves finalization of a block.

successor_qc CCD_RawQuorumCertificate

The certificate that proves there is a successor block.

successor_proof CCD_SuccessorProof

The proof that the successor block is valid.

CCD_RawFinalizerRound

A round of finalization in the consensus protocol.

GRPC documentation: concordium.v2.RawFinalizerRound

Attributes:

Name Type Description
round CCD_Round

The round number in the consensus protocol.

finalizers list[CCD_FinalizerIndex]

The list of finalizer indices who participated in this round.

CCD_RawQuorumCertificate

A raw quorum certificate from the consensus protocol.

GRPC documentation: concordium.v2.RawQuorumCertificate

Attributes:

Name Type Description
block_hash CCD_BlockHash

The block hash this certificate certifies.

round CCD_Round

The round in which the certificate was created.

epoch CCD_Epoch

The epoch in which the certificate was created.

aggregate_signature CCD_QuorumSignature

The aggregate signature of all signers.

signatories list[CCD_FinalizerIndex]

The indices of the finalizers who signed this certificate.

CCD_RawTimeoutCertificate

A raw timeout certificate in the consensus protocol.

GRPC documentation: concordium.v2.RawTimeoutCertificate

Attributes:

Name Type Description
round CCD_Round

The round associated with the timeout certificate.

min_epoch CCD_Epoch

The minimum epoch associated with the timeout certificate.

qc_rounds_first_epoch list[CCD_RawFinalizerRound]

List of finalizer rounds for the first epoch.

qc_rounds_second_epoch list[CCD_RawFinalizerRound]

List of finalizer rounds for the second epoch.

aggregate_signature CCD_TimeoutSignature

The aggregated signature by the finalization committee that witnessed the 'round' timed out.

CCD_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.

GRPC documentation: concordium.v2.RejectReason

Attributes:

Name Type Description
module_not_wf Optional[CCD_Empty]

Raised while validating a Wasm module that is not well formed.

module_hash_already_exists Optional[CCD_ModuleRef]

The smart contract module hash already exists.

invalid_account_reference Optional[CCD_AccountAddress]

Account does not exist.

invalid_init_method Optional[CCD_RejectReason_InvalidInitMethod]

Reference to a non-existing contract init method.

invalid_receive_method Optional[CCD_RejectReason_InvalidReceiveMethod]

Reference to a non-existing contract receive method.

invalid_module_reference Optional[CCD_ModuleRef]

Reference to a non-existing smart contract module.

invalid_contract_address Optional[CCD_ContractAddress]

Contract instance does not exist.

runtime_failure Optional[CCD_Empty]

Runtime exception occurred when running either the init or receive method.

amount_too_large Optional[CCD_RejectReason_AmountTooLarge]

When one wishes to transfer an amount from A to B but there are not enough funds on account/contract A to make this possible.

serialization_failure Optional[CCD_Empty]

Serialization of the body failed.

out_of_energy Optional[CCD_Empty]

We ran of out energy to process this transaction.

rejected_init Optional[CCD_RejectReason_RejectedInit]

Rejected due to contract logic in init function of a contract.

rejected_receive Optional[CCD_RejectReason_RejectedReceive]

Rejected due to contract logic in receive function of a contract.

invalid_proof Optional[CCD_Empty]

Proof that the validator owns relevant private keys is not valid.

already_a_baker Optional[CCD_BakerId]

Tried to add validator for an account that already has a validator.

not_a_baker Optional[CCD_AccountAddress]

Tried to remove a validator for an account that has no validator.

insufficient_balance_for_baker_stake Optional[CCD_Empty]

The amount on the account was insufficient to cover the proposed stake.

stake_under_minimum_threshold_for_baking Optional[CCD_Empty]

The amount provided is under the threshold required for becoming a validator.

baker_in_cooldown Optional[CCD_Empty]

The change could not be made because the validator is in cooldown for another change.

duplicate_aggregation_key Optional[CCD_BakerAggregationVerifyKey]

A validator with the given aggregation key already exists.

non_existent_credential_id Optional[CCD_Empty]

Encountered credential ID that does not exist.

key_index_already_in_use Optional[CCD_Empty]

Attempted to add an account key to a key index already in use.

invalid_account_threshold Optional[CCD_Empty]

When the account threshold is updated, it must not exceed the amount of existing keys.

invalid_credential_key_sign_threshold Optional[CCD_Empty]

When the credential key threshold is updated, it must not exceed the amount of existing keys.

invalid_encrypted_amount_transfer_proof Optional[CCD_Empty]

Proof for an encrypted amount transfer did not validate.

invalid_transfer_to_public_proof Optional[CCD_Empty]

Proof for a secret to public transfer did not validate.

encrypted_amount_self_transfer Optional[CCD_AccountAddress]

Account tried to transfer an encrypted amount to itself, that's not allowed.

invalid_index_on_encrypted_transfer Optional[CCD_Empty]

The provided index is below the start index or above startIndex + length incomingAmounts.

zero_scheduledAmount Optional[CCD_Empty]

The transfer with schedule is going to send 0 tokens.

non_increasing_schedule Optional[CCD_Empty]

The transfer with schedule has a non strictly increasing schedule.

first_scheduled_release_expired Optional[CCD_Empty]

The first scheduled release in a transfer with schedule has already expired.

scheduled_self_transfer Optional[CCD_AccountAddress]

Account tried to transfer with schedule to itself, that's not allowed.

invalid_credentials Optional[CCD_Empty]

At least one of the credentials was either malformed or its proof was incorrect.

duplicate_cred_ids Optional[CCD_RejectReason_DuplicateCredIds]

Some of the credential IDs already exist or are duplicated in the transaction.

non_existent_cred_ids Optional[CCD_RejectReason_NonExistentCredIds]

A credential id that was to be removed is not part of the account.

remove_first_credential Optional[CCD_Empty]

Attempt to remove the first credential.

credential_holder_did_not_sign Optional[CCD_Empty]

The credential holder of the keys to be updated did not sign the transaction.

not_allowed_multiple_credentials Optional[CCD_Empty]

Account is not allowed to have multiple credentials because it contains a non-zero encrypted transfer.

not_allowed_to_receive_encrypted Optional[CCD_Empty]

The account is not allowed to receive encrypted transfers because it has multiple credentials.

not_allowed_to_handle_encrypted Optional[CCD_Empty]

The account is not allowed to send encrypted transfers (or transfer from/to public to/from encrypted).

missing_baker_add_parameters Optional[CCD_Empty]

A configure validator transaction is missing one or more arguments in order to add a validator.

finalization_reward_commission_not_in_range Optional[CCD_Empty]

Finalization reward commission is not in the valid range for a validator.

baking_reward_commission_not_in_range Optional[CCD_Empty]

Baking reward commission is not in the valid range for a validator.

transaction_fee_commission_not_in_range Optional[CCD_Empty]

Transaction fee commission is not in the valid range for a validator.

already_a_delegator Optional[CCD_Empty]

Tried to add validator for an account that already has a delegator.

insufficient_balance_for_delegation_stake Optional[CCD_Empty]

The amount on the account was insufficient to cover the proposed stake.

missing_delegation_add_parameters Optional[CCD_Empty]

A configure delegation transaction is missing one or more arguments in order to add a delegator.

insufficient_delegation_stake Optional[CCD_Empty]

Delegation stake when adding a delegator was 0.

delegator_in_cooldown Optional[CCD_Empty]

Account is not a delegation account.

not_a_delegator Optional[CCD_AccountAddress]

Account is not a delegation account.

delegation_target_not_a_baker Optional[CCD_BakerId]

Delegation target is not a validator.

stake_over_maximum_threshold_for_pool Optional[CCD_Empty]

The amount would result in pool capital higher than the maximum threshold.

pool_would_become_over_delegated Optional[CCD_Empty]

The amount would result in pool with a too high fraction of delegated capital.

pool_closed Optional[CCD_Empty]

The pool is not open to delegators.

CCD_RejectReason_AmountTooLarge

When one wishes to transfer an amount from A to B but there are not enough funds on account/contract A to make this possible. The data are the from address and the amount to transfer.

GRPC documentation: concordium.v2.RejectReason.AmountTooLarge

Attributes:

Name Type Description
address CCD_Address

The from address.

amount microCCD

The amount to transfer.

CCD_RejectReason_DuplicateCredIds

Some of the credential IDs already exist or are duplicated in the transaction.

GRPC documentation: concordium.v2.RejectReason.DuplicateCredIds

Attributes:

Name Type Description
ids list[CCD_CredentialRegistrationId]

The credential IDs that were duplicated.

CCD_RejectReason_InvalidInitMethod

Reference to a non-existing contract init method.

GRPC documentation: concordium.v2.RejectReason.InvalidInitMethod

Attributes:

Name Type Description
module_ref CCD_ModuleRef

Reference to the module.

init_name CCD_InitName

Name of the initialization method.

CCD_RejectReason_InvalidReceiveMethod

Reference to a non-existing contract receive method.

GRPC documentation: concordium.v2.RejectReason.InvalidReceiveMethod

Attributes:

Name Type Description
module_ref CCD_ModuleRef

Reference to the module.

receive_name CCD_ReceiveName

Name of the receive method.

CCD_RejectReason_NonExistentCredIds

A credential id that was to be removed is not part of the account.

GRPC documentation: concordium.v2.RejectReason.NonExistentCredIds

Attributes:

Name Type Description
ids list[CCD_CredentialRegistrationId]

The credential IDs that were not found.

CCD_RejectReason_RejectedInit

Rejected due to contract logic in init function of a contract.

GRPC documentation: concordium.v2.RejectReason.RejectedInit

Attributes:

Name Type Description
reject_reason int

The rejection reason code.

CCD_RejectReason_RejectedReceive

Rejected due to contract logic in receive function of a contract.

GRPC documentation: concordium.v2.RejectReason.RejectedReceive

Attributes:

Name Type Description
reject_reason int

The rejection reason code.

contract_address CCD_ContractAddress

The contract address.

receive_name CCD_ReceiveName

Name of the receive method.

parameter CCD_Parameter

The parameter passed to the method.

CCD_Release

An individual release of a locked balance.

GRPC documentation: concordium.v2.Release

Attributes:

Name Type Description
timestamp CCD_TimeStamp

Effective time of the release in milliseconds since unix epoch.

amount microCCD

Amount to be released.

transactions list[CCD_TransactionHash]

List of transaction hashes that contribute a balance to this release.

CCD_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.

GRPC documentation: concordium.v2.ReleaseSchedule

Attributes:

Name Type Description
total microCCD

Total amount locked in the release schedule.

schedules list[CCD_Release]

A list of releases, ordered by increasing timestamp.

CCD_RewardPeriodLength

Length of a reward period in epochs. Must always be a strictly positive number.

GRPC documentation: concordium.v2.RewardPeriodLength

Attributes:

Name Type Description
value Epoch

The number of epochs in the reward period.

CCD_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.

GRPC documentation: concordium.v2.RootUpdate

Attributes:

Name Type Description
root_keys_update Optional[CCD_HigherLevelKeys]

The root keys were updated.

level_1_keys_update Optional[CCD_HigherLevelKeys]

The level 1 keys were updated.

level_2_keys_update_v0 Optional[CCD_AuthorizationsV0]

The level 2 keys were updated.

level_2_keys_update_v1 Optional[CCD_AuthorizationsV1]

The level 2 keys were updated. This is similar to level_2_keys_update_v0 except that a few more keys can be updated.

CCD_RoundExistingBlock

An existing block in the consensus round.

GRPC documentation: concordium.v2.RoundExistingBlock

Attributes:

Name Type Description
round CCD_Round

The round number in which the block exists.

validator CCD_BakerId

The validator who created this block.

block CCD_BlockHash

The hash of the block.

CCD_RoundExistingQC

A quorum certificate that exists for a round in consensus.

GRPC documentation: concordium.v2.RoundExistingQC

Attributes:

Name Type Description
round CCD_Round

The round number for which the QC exists.

epoch CCD_Epoch

The epoch in which the QC was created.

CCD_RoundStatus

Status of a round in the consensus protocol.

GRPC documentation: concordium.v2.RoundStatus

Attributes:

Name Type Description
current_round CCD_Round

The current round in progress.

highest_certified_block CCD_RawQuorumCertificate

The highest certified block in the current round.

previous_round_timeout Optional[CCD_RoundTimeout]

The timeout of the previous round, if any.

current_epoch CCD_Epoch

The current epoch in progress.

last_epoch_finalization_entry Optional[CCD_RawFinalizationEntry]

The finalization entry of the last epoch, if any.

current_timeout CCD_Duration

The current timeout duration.

CCD_RoundTimeout

A timeout event in the consensus protocol.

GRPC documentation: concordium.v2.RoundTimeout

Attributes:

Name Type Description
timeout_certificate CCD_RawTimeoutCertificate

The certificate indicating that a timeout has occurred.

quorum_certificate CCD_RawQuorumCertificate

The highest quorum certificate known when the timeout occurred.

CCD_ShortBlockInfo

CCD_ShortBlockInfo represents some info for a block (custom class).

Attributes:

Name Type Description
height int

The height of the block in the blockchain.

hash CCD_BlockHash

The hash of the block.

slot_time CCD_TimeStamp

The timestamp of the block slot.

CCD_StakePendingChange

A pending change to an account's stake. Either a reduction in stake amount, or complete removal of stake.

GRPC documentation: concordium.v2.StakePendingChange

Attributes:

Name Type Description
reduce Optional[CCD_StakePendingChange_Reduce]

Details of a pending reduction in stake.

remove Optional[CCD_StakePendingChange_Remove]

Details of a pending removal of stake.

CCD_StakePendingChange_Reduce

The validator's stake will be reduced at the specified time.

GRPC documentation: concordium.v2.StakePendingChange.Reduce

Attributes:

Name Type Description
new_stake microCCD

The reduced stake amount.

effective_time CCD_TimeStamp

The time at which the reduction takes effect.

CCD_TimeOutParameters

Parameters controlling timeouts in the consensus protocol.

GRPC documentation: concordium.v2.TimeoutParameters

Attributes:

Name Type Description
timeout_base CCD_Duration

The base duration for timeouts.

timeout_increase CCD_Ratio

The multiplicative factor by which timeout increases each time a timeout triggers.

timeout_decrease CCD_Ratio

The multiplicative factor by which timeout decreases after a successful round.

CCD_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.

GRPC documentation: concordium.v2.TimeParametersCpv1

Attributes:

Name Type Description
reward_period_length RewardPeriodLength

Length of the reward period in epochs.

mint_per_payday CCD_MintRate

The rate at which CCDs are minted at each payday.

CCD_TimeoutMessage

A timeout message in the consensus protocol.

GRPC documentation: concordium.v2.TimeoutMessage

Attributes:

Name Type Description
finalizer [CCD_FinalizerIndex]

The index of the finalizer who created this message.

round CCD_Round

The round number this timeout is for.

epoch CCD_Epoch

The epoch this timeout is for.

quorum_certificate CCD_RawQuorumCertificate

The highest quorum certificate known to the sender.

signature CCD_TimeoutSignature

The signature on this timeout message.

message_signature CCD_BlockSignature

The block signature on this timeout message.

CCD_TimeoutMessages

Lists of timeout messages for different epochs.

GRPC documentation: concordium.v2.TimeoutMessages

Attributes:

Name Type Description
first_epoch CCD_Epoch

The first epoch for which we have timeout messages.

first_epoch_timeouts list[CCD_TimeoutMessage]

Timeout messages from the first epoch.

second_epoch_timeouts list[CCD_TimeoutMessage]

Timeout messages from the second epoch.

CCD_TokenModuleRejectReasonDetails

NOT mirrored to an official class. Represents the state of a module in the blockchain.

CCD_TokenomicsInfo

Contains information related to tokenomics at the end of a given block.

GRPC documentation: concordium.v2.TokenomicsInfo

Attributes:

Name Type Description
v0 Optional[CCD_TokenomicsInfo_V0]

Version 0 tokenomics information, used in earlier protocol versions.

v1 Optional[CCD_TokenomicsInfo_V1]

Version 1 tokenomics information, used in later protocol versions.

CCD_TokenomicsInfo_V0

Version 0 tokenomics information.

GRPC documentation: concordium.v2.TokenomicsInfo.V0

Attributes:

Name Type Description
total_amount microCCD

The total CCD in existence.

total_encrypted_amount microCCD

The total CCD in encrypted balances.

baking_reward_account microCCD

The amount in the baking reward account.

finalization_reward_account microCCD

The amount in the finalization reward account.

gas_account microCCD

The amount in the GAS account.

protocol_version int

The protocol version.

CCD_TokenomicsInfo_V1

Version 1 tokenomics information.

GRPC documentation: concordium.v2.TokenomicsInfo.V1

Attributes:

Name Type Description
total_amount microCCD

The total CCD in existence.

total_encrypted_amount microCCD

The total CCD in encrypted balances.

baking_reward_account microCCD

The amount in the baking reward account.

finalization_reward_account microCCD

The amount in the finalization reward account.

gas_account microCCD

The amount in the GAS account.

foundation_transaction_rewards microCCD

The transaction reward fraction accruing to the foundation (to be paid at next payday).

next_payday_time CCD_TimeStamp

The time of the next payday.

next_payday_mint_rate CCD_MintRate

The rate at which CCD will be minted (as a proportion of the total supply) at the next payday.

total_staked_capital microCCD

The total capital put up as stake by bakers and delegators.

protocol_version ProtocolVersion

The protocol version.

CCD_TransactionFeeDistribution

Parameters determining the distribution of transaction fees.

GRPC documentation: concordium.v2.TransactionFeeDistribution

Attributes:

Name Type Description
validator CCD_AmountFraction

The fraction allocated to the validator.

gas_account CCD_AmountFraction

The fraction allocated to the GAS account.

CCD_TransactionType

Different types of transactions that can be submitted to the chain.

GRPC documentation: concordium.v2.TransactionType

CCD_TransferredWithSchedule

A transfer with schedule was performed. This is the result of a successful TransferWithSchedule transaction.

GRPC documentation: concordium.v2.AccountTransactionEffects.TransferredWithSchedule

Attributes:

Name Type Description
receiver CCD_AccountAddress

Receiver account.

amount list[CCD_NewRelease]

The list of releases. Ordered by increasing timestamp.

memo Optional[CCD_Memo]

Optional memo.

CCD_UpdateDetails

Details of an update instruction. These are free, and we only ever get a response for them if the update is successfully enqueued, hence no failure cases.

GRPC documentation: concordium.v2.UpdateDetails

Attributes:

Name Type Description
effective_time TransactionTime

The time at which the update will be effective.

payload UpdatePayload

The payload for the update.

CCD_UpdatePayload

The payload of a chain update.

GRPC documentation: concordium.v2.UpdatePayload

Attributes:

Name Type Description
protocol_update Optional[CCD_ProtocolUpdate]

The protocol version was updated.

election_difficulty_update Optional[CCD_ElectionDifficulty]

The election difficulty was updated.

euro_per_energy_update Optional[CCD_ExchangeRate]

The euro per energy exchange rate was updated.

micro_ccd_per_euro_update Optional[CCD_ExchangeRate]

The microCCD per euro exchange rate was updated.

foundation_account_update Optional[CCD_AccountAddress]

The foundation account address was updated.

mint_distribution_update Optional[CCD_MintDistributionCpv0]

The mint distribution was updated (protocol version 1-3).

transaction_fee_distribution_update Optional[CCD_TransactionFeeDistribution]

The transaction fee distribution was updated.

gas_rewards_update Optional[CCD_GasRewards]

The gas rewards were updated (protocol version 1-5).

baker_stake_threshold_update Optional[CCD_BakerStakeThreshold]

The minimum amount of CCD needed to become a validator was updated.

root_update Optional[CCD_RootUpdate]

The root keys were updated.

level_1_update Optional[CCD_Level1Update]

The level 1 keys were updated.

add_anonymity_revoker_update Optional[CCD_ArInfo]

An anonymity revoker was added.

add_identity_provider_update Optional[CCD_IpInfo]

An identity provider was added.

cooldown_parameters_cpv_1_update Optional[CCD_CooldownParametersCpv1]

The cooldown parameters were updated.

pool_parameters_cpv_1_update Optional[CCD_PoolParametersCpv1]

The pool parameters were updated.

time_parameters_cpv_1_update Optional[CCD_TimeParametersCpv1]

The time parameters were updated.

mint_distribution_cpv_1_update Optional[CCD_MintDistributionCpv1]

The mint distribution was updated (protocol version 4+).

gas_rewards_cpv_2_update Optional[CCD_GasRewardsCpv2]

The gas rewards were updated (protocol version 6+).

timeout_parameters_update Optional[CCD_TimeoutParameters]

The consensus timeouts were updated.

min_block_time_update Optional[CCD_Duration]

The minimum time between blocks was updated.

block_energy_limit_update Optional[CCD_Energy]

The block energy limit was updated.

finalization_committee_parameters_update Optional[CCD_FinalizationCommitteeParameters]

The finalization committee parameters were updated.

validator_score_parameters_update Optional[CCD_ValidatorScoreParameters]

The validator score parameters were updated.

CCD_ValidatorScoreParameters

Parameters used by the validator scoring system for determining validator suspensions.

GRPC documentation: concordium.v2.ValidatorScoreParameters

Attributes:

Name Type Description
maximum_missed_rounds int

The maximal number of missed rounds before a validator gets suspended.

CCD_VersionedModuleSource

Different versions of smart contract module sources.

GRPC documentation: concordium.v2.VersionedModuleSource

Attributes:

Name Type Description
v0 Optional[CCD_VersionedModuleSource_ModuleSourceV0]

Version 0 module source format.

v1 Optional[CCD_VersionedModuleSource_ModuleSourceV1]

Version 1 module source format, which includes source code.

CCD_WinningBaker

Details of which validator won the lottery in a given round in consensus version 1.

GRPC documentation: concordium.v2.WinningBaker

Attributes:

Name Type Description
round int

The round number.

winnter int

The validator that won the round.

present bool

True if the validator produced a block in this round on the finalized chain, and False otherwise.

CCD_YearMonth

Representation of the pair of a year and month.

GRPC documentation: concordium.v2.YearMonth

Attributes:

Name Type Description
year int

The year value.

month int

The month value.

CoolDownStatus

Enum representing the different stages of cooldown status.

Attributes:

Name Type Description
COOLDOWN int

Represents the cooldown stage with a value of 0.

PRE_COOLDOWN int

Represents the pre-cooldown stage with a value of 1.

PRE_PRE_COOLDOWN int

Represents the pre-pre-cooldown stage with a value of 2.

CredentialDocType

Enum class representing different types of credential documents.

Attributes:

Name Type Description
na str

Represents an unspecified or unknown document type.

Passport str

Represents a passport document type.

National_ID_Card str

Represents a national ID card document type.

Driving_License str

Represents a driving license document type.

Immigration_Card str

Represents an immigration card document type.

CredentialElement

Enum class representing different types of credential elements.

Attributes:

Name Type Description
firstName int

Represents the first name of an individual.

lastName int

Represents the last name of an individual.

sex int

Represents the sex of an individual.

dob int

Represents the date of birth of an individual.

countryOfResidence int

Represents the country of residence of an individual.

nationality int

Represents the nationality of an individual.

idDocType int

Represents the type of identification document.

idDocNo int

Represents the identification document number.

idDocIssuer int

Represents the issuer of the identification document.

idDocIssuedAt int

Represents the issuance date of the identification document.

idDocExpiresAt int

Represents the expiration date of the identification document.

nationalIdNo int

Represents the national identification number.

taxIdNo int

Represents the tax identification number.

lei int

Represents the Legal Entity Identifier.

legalName int

Represents the legal name of a business entity.

legalJurisdictionCountry int

Represents the legal jurisdiction country of a business entity.

businessNumber int

Represents the business number of a business entity.

registrationAuthority int

Represents the registration authority of a business entity.

ProtocolVersions

Enum representing different protocol versions.

Attributes:

Name Type Description
PROTOCOL_VERSION_1 int

Protocol version 1.

PROTOCOL_VERSION_2 int

Protocol version 2.

PROTOCOL_VERSION_3 int

Protocol version 3.

PROTOCOL_VERSION_4 int

Protocol version 4.

PROTOCOL_VERSION_5 int

Protocol version 5.

PROTOCOL_VERSION_6 int

Protocol version 6.

PROTOCOL_VERSION_7 int

Protocol version 7.

PROTOCOL_VERSION_8 int

Protocol version 8.