Cardano Module
This reference covers v1beta, generated from spec v0.19.2.
AddressPattern
Pattern of an address that can be used to evaluate matching predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| exact_address | bytes | optional | The address should match this exact address value. |
| payment_part | bytes | optional | The payment part of the address should match this value. |
| delegation_part | bytes | optional | The delegation part of the address should match this value. |
Anchor
| Field | Type | Label | Description |
|---|---|---|---|
| url | string | ||
| content_hash | bytes |
Asset
Represents a custom asset in the Cardano blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| name | bytes | Name of the custom asset. | |
| quantity | BigInt | Quantity of the custom asset. This can be negative only if it is in a Tx.mint field and the transaction is burning tokens. |
AssetPattern
Pattern of a native asset that can be used to evaluate matching predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| policy_id | bytes | optional | The asset should belong to this policy id |
| asset_name | bytes | optional | The asset should present this name |
AuthCommitteeHotCert
| Field | Type | Label | Description |
|---|---|---|---|
| committee_cold_credential | StakeCredential | ||
| committee_hot_credential | StakeCredential |
AuxData
Auxiliary data not directly tied to the validation process
| Field | Type | Label | Description |
|---|---|---|---|
| metadata | Metadata | repeated | List of auxiliary metadata elements. |
| scripts | Script | repeated | List of auxiliary scripts. |
BigInt
Represents a big integer for Plutus data in Cardano. The representation here follows CBOR specification for bignums: https://www.rfc-editor.org/rfc/rfc8949.html#name-bignums (opens in a new tab) section 3.4.3.
| Field | Type | Label | Description |
|---|---|---|---|
| int | int64 | Stores value fitting within int64 range | |
| big_u_int | bytes | Stores unsigned value exceeding int64 range | |
| big_n_int | bytes | Stores negative value n exceeding int64 range as -1 - n |
Block
Represents a complete block, including header and body.
| Field | Type | Label | Description |
|---|---|---|---|
| header | BlockHeader | Block header. | |
| body | BlockBody | Block body. | |
| timestamp | uint64 | Block ms timestamp |
BlockBody
Contains the transaction data for a block.
| Field | Type | Label | Description |
|---|---|---|---|
| tx | Tx | repeated | List of transactions. |
BlockHeader
Contains the header information for a block.
| Field | Type | Label | Description |
|---|---|---|---|
| slot | uint64 | Slot number. | |
| hash | bytes | Block hash. | |
| height | uint64 | Block height. |
BlockVersionData
| Field | Type | Label | Description |
|---|---|---|---|
| script_version | uint32 | ||
| slot_duration | string | ||
| max_block_size | string | ||
| max_header_size | string | ||
| max_tx_size | string | ||
| max_proposal_size | string | ||
| mpc_thd | string | ||
| heavy_del_thd | string | ||
| update_vote_thd | string | ||
| update_proposal_thd | string | ||
| update_implicit | string | ||
| softfork_rule | SoftforkRule | ||
| tx_fee_policy | TxFeePolicy | ||
| unlock_stake_epoch | string |
BootstrapWitness
Represents bootstrap keys from Byron era
| Field | Type | Label | Description |
|---|---|---|---|
| vkey | bytes | Verification key. | |
| signature | bytes | Signature generated using the associated private key. | |
| chain_code | bytes | 32 bytes of chain code | |
| attributes | bytes | key attributes |
Certificate
Represents a certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| stake_registration | StakeCredential | Stake registration certificate. | |
| stake_deregistration | StakeCredential | Stake deregistration certificate. | |
| stake_delegation | StakeDelegationCert | Stake delegation certificate. | |
| pool_registration | PoolRegistrationCert | Pool registration certificate. | |
| pool_retirement | PoolRetirementCert | Pool retirement certificate. | |
| genesis_key_delegation | GenesisKeyDelegationCert | Genesis key delegation certificate. | |
| mir_cert | MirCert | Move instantaneous rewards certificate. | |
| reg_cert | RegCert | Registration certificate. | |
| unreg_cert | UnRegCert | Unregistration certificate. | |
| vote_deleg_cert | VoteDelegCert | Vote delegation certificate. | |
| stake_vote_deleg_cert | StakeVoteDelegCert | Stake and vote delegation certificate. | |
| stake_reg_deleg_cert | StakeRegDelegCert | Stake registration and delegation certificate. | |
| vote_reg_deleg_cert | VoteRegDelegCert | Vote registration and delegation certificate. | |
| stake_vote_reg_deleg_cert | StakeVoteRegDelegCert | Stake and vote registration and delegation certificate. | |
| auth_committee_hot_cert | AuthCommitteeHotCert | Authorize committee hot key certificate. | |
| resign_committee_cold_cert | ResignCommitteeColdCert | Resign committee cold key certificate. | |
| reg_drep_cert | RegDRepCert | Register DRep certificate. | |
| unreg_drep_cert | UnRegDRepCert | Unregister DRep certificate. | |
| update_drep_cert | UpdateDRepCert | Update DRep certificate. | |
| redeemer | Redeemer | Redeemer for the Plutus script. |
CertificatePattern
Pattern of a certificate that can be used to evaluate matching predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| stake_registration | StakeCredential | Match stake registration for this credential | |
| stake_deregistration | StakeCredential | Match stake deregistration for this credential | |
| stake_delegation | StakeDelegationPattern | Match stake delegation pattern | |
| pool_registration | PoolRegistrationPattern | Match pool registration pattern | |
| pool_retirement | PoolRetirementPattern | Match pool retirement pattern | |
| any_stake_credential | bytes | Match any certificate involving this stake credential | |
| any_pool_keyhash | bytes | Match any certificate involving this pool | |
| any_drep | bytes | Match any certificate involving this DRep |
Collateral
Represents the collateral information for a transaction.
| Field | Type | Label | Description |
|---|---|---|---|
| collateral | TxInput | repeated | Collateral inputs for the transaction. |
| collateral_return | TxOutput | Collateral return in case of script failure. | |
| total_collateral | BigInt | Total amount of collateral. |
Committee
| Field | Type | Label | Description |
|---|---|---|---|
| members | Committee.MembersEntry | repeated | |
| threshold | RationalNumber |
Committee.MembersEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | uint64 |
Constitution
| Field | Type | Label | Description |
|---|---|---|---|
| anchor | Anchor | Anchor to the new document | |
| hash | bytes | Hash of the document |
Constr
Represents a constructor for Plutus data in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| tag | uint32 | ||
| any_constructor | uint64 | ||
| fields | PlutusData | repeated |
CostModel
| Field | Type | Label | Description |
|---|---|---|---|
| values | int64 | repeated |
CostModelMap
| Field | Type | Label | Description |
|---|---|---|---|
| plutus_v1 | CostModel | ||
| plutus_v2 | CostModel | ||
| plutus_v3 | CostModel | ||
| plutus_v4 | CostModel |
CostModels
| Field | Type | Label | Description |
|---|---|---|---|
| plutus_v1 | CostModel | ||
| plutus_v2 | CostModel | ||
| plutus_v3 | CostModel | ||
| plutus_v4 | CostModel |
DRep
| Field | Type | Label | Description |
|---|---|---|---|
| addr_key_hash | bytes | Address key hash | |
| script_hash | bytes | Script hash | |
| abstain | bool | Abstain | |
| no_confidence | bool | No confidence |
DRepVotingThresholds
| Field | Type | Label | Description |
|---|---|---|---|
| motion_no_confidence | RationalNumber | ||
| committee_normal | RationalNumber | ||
| committee_no_confidence | RationalNumber | ||
| update_to_constitution | RationalNumber | ||
| hard_fork_initiation | RationalNumber | ||
| pp_network_group | RationalNumber | ||
| pp_economic_group | RationalNumber | ||
| pp_technical_group | RationalNumber | ||
| pp_gov_group | RationalNumber | ||
| treasury_withdrawal | RationalNumber |
Datum
| Field | Type | Label | Description |
|---|---|---|---|
| hash | bytes | Hash of this datum as seen on-chain | |
| payload | PlutusData | optional | Parsed Plutus data payload |
| original_cbor | bytes | optional | Original cbor-encoded data as seen on-chain |
EraBoundary
| Field | Type | Label | Description |
|---|---|---|---|
| time | uint64 | ms timestamp | |
| slot | uint64 | absolute slot number of the first block of this era | |
| epoch | uint64 | first epoch for this era |
EraSummaries
| Field | Type | Label | Description |
|---|---|---|---|
| summaries | EraSummary | repeated |
EraSummary
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | name of the era (ex: "shelley") | |
| start | EraBoundary | start of this era | |
| end | EraBoundary | end of this era (if the era has a well-defined ending) | |
| protocol_params | PParams | protocol parameters for this era |
EvalReport
A single evaluation report entry, used for both script errors and execution traces. The purpose and index fields identify which redeemer produced the entry, allowing the client to correlate errors and traces with specific script executions.
| Field | Type | Label | Description |
|---|---|---|---|
| msg | string | Human-readable message. | |
| purpose | RedeemerPurpose | Purpose of the redeemer that produced this entry. | |
| index | uint32 | 0-based index of the redeemer within its purpose. |
ExPrices
| Field | Type | Label | Description |
|---|---|---|---|
| steps | RationalNumber | ||
| memory | RationalNumber |
ExUnits
| Field | Type | Label | Description |
|---|---|---|---|
| steps | uint64 | ||
| memory | uint64 |
ExtraEntropy
| Field | Type | Label | Description |
|---|---|---|---|
| tag | string |
GenDelegs
| Field | Type | Label | Description |
|---|---|---|---|
| delegate | string | ||
| vrf | string |
Genesis
Unified Genesis configuration containing all parameters from all eras
| Field | Type | Label | Description |
|---|---|---|---|
| avvm_distr | Genesis.AvvmDistrEntry | repeated | ============ Byron Era Fields ============ |
| block_version_data | BlockVersionData | ||
| fts_seed | string | ||
| protocol_consts | ProtocolConsts | ||
| start_time | uint64 | ||
| boot_stakeholders | Genesis.BootStakeholdersEntry | repeated | |
| heavy_delegation | Genesis.HeavyDelegationEntry | repeated | |
| non_avvm_balances | Genesis.NonAvvmBalancesEntry | repeated | |
| vss_certs | Genesis.VssCertsEntry | repeated | |
| active_slots_coeff | RationalNumber | ============ Shelley Era Fields ============ | |
| epoch_length | uint32 | ||
| gen_delegs | Genesis.GenDelegsEntry | repeated | |
| initial_funds | Genesis.InitialFundsEntry | repeated | |
| max_kes_evolutions | uint32 | ||
| max_lovelace_supply | BigInt | ||
| network_id | string | ||
| network_magic | uint32 | ||
| protocol_params | PParams | Using PParams as it's a superset of all protocol parameters | |
| security_param | uint32 | ||
| slot_length | uint32 | ||
| slots_per_kes_period | uint32 | ||
| system_start | string | ||
| update_quorum | uint32 | ||
| lovelace_per_utxo_word | BigInt | ============ Alonzo Era Fields ============ | |
| execution_prices | ExPrices | ||
| max_tx_ex_units | ExUnits | ||
| max_block_ex_units | ExUnits | ||
| max_value_size | uint32 | ||
| collateral_percentage | uint32 | ||
| max_collateral_inputs | uint32 | ||
| cost_models | CostModelMap | ||
| committee | Committee | ============ Conway Era Fields ============ | |
| constitution | Constitution | ||
| committee_min_size | uint64 | ||
| committee_max_term_length | uint64 | ||
| gov_action_lifetime | uint64 | ||
| gov_action_deposit | BigInt | ||
| drep_deposit | BigInt | ||
| drep_activity | uint64 | ||
| min_fee_ref_script_cost_per_byte | RationalNumber | ||
| drep_voting_thresholds | DRepVotingThresholds | ||
| pool_voting_thresholds | PoolVotingThresholds |
Genesis.AvvmDistrEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
Genesis.BootStakeholdersEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | uint64 |
Genesis.GenDelegsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | GenDelegs |
Genesis.HeavyDelegationEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | HeavyDelegation |
Genesis.InitialFundsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | BigInt |
Genesis.NonAvvmBalancesEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
Genesis.VssCertsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | VssCert |
GenesisKeyDelegationCert
Represents a genesis key delegation certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| genesis_hash | bytes | Genesis hash. | |
| genesis_delegate_hash | bytes | Genesis delegate hash. | |
| vrf_keyhash | bytes | VRF key hash. |
GetStakePoolDistribution
Stake pool distribution query. Mirrors Ouroboros GetPoolDistr / GetFilteredPoolDistr.
| Field | Type | Label | Description |
|---|---|---|---|
| pool_keyhashes | bytes | repeated | If non-empty, restrict the result to the listed pool key hashes. If empty, return the distribution for every pool. |
GovernanceAction
Define a Governance Action
| Field | Type | Label | Description |
|---|---|---|---|
| parameter_change_action | ParameterChangeAction | Change on-chain parameters | |
| hard_fork_initiation_action | HardForkInitiationAction | Initiate a Hard Fork | |
| treasury_withdrawals_action | TreasuryWithdrawalsAction | Withdraw from the Treasury | |
| no_confidence_action | NoConfidenceAction | ||
| update_committee_action | UpdateCommitteeAction | Update the Constitution Committee | |
| new_constitution_action | NewConstitutionAction | Replace the Constitution | |
| info_action | InfoAction | Info action |
GovernanceActionId
| Field | Type | Label | Description |
|---|---|---|---|
| transaction_id | bytes | ||
| governance_action_index | uint32 |
GovernanceActionProposal
Define a governance action proposal
| Field | Type | Label | Description |
|---|---|---|---|
| deposit | BigInt | The amount deposited for the governance action | |
| reward_account | bytes | The reward account the deposit should be returned to | |
| gov_action | GovernanceAction | ||
| anchor | Anchor |
HardForkInitiationAction
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId | ||
| protocol_version | ProtocolVersion | The protocol version to fork to |
HeavyDelegation
| Field | Type | Label | Description |
|---|---|---|---|
| cert | string | ||
| delegate_pk | string | ||
| issuer_pk | string | ||
| omega | uint32 |
InfoAction
Metadata
| Field | Type | Label | Description |
|---|---|---|---|
| label | uint64 | ||
| value | Metadatum |
Metadatum
| Field | Type | Label | Description |
|---|---|---|---|
| int | int64 | ||
| bytes | bytes | ||
| text | string | ||
| array | MetadatumArray | ||
| map | MetadatumMap |
MetadatumArray
| Field | Type | Label | Description |
|---|---|---|---|
| items | Metadatum | repeated |
MetadatumMap
| Field | Type | Label | Description |
|---|---|---|---|
| pairs | MetadatumPair | repeated |
MetadatumPair
| Field | Type | Label | Description |
|---|---|---|---|
| key | Metadatum | ||
| value | Metadatum |
MirCert
Represents a move instantaneous reward certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| from | MirSource | ||
| to | MirTarget | repeated | |
| other_pot | uint64 |
MirTarget
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| delta_coin | BigInt |
Multiasset
Represents a multi-asset group in the Cardano blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| policy_id | bytes | Policy ID governing the custom assets. | |
| assets | Asset | repeated | List of custom assets. |
NativeScript
Represents a native script in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| script_pubkey_hash | bytes | Script based on an address key hash. | |
| script_all | NativeScriptList | Script that requires all nested scripts to be satisfied. | |
| script_any | NativeScriptList | Script that requires any of the nested scripts to be satisfied. | |
| script_n_of_k | ScriptNOfK | Script that requires k out of n nested scripts to be satisfied. | |
| invalid_before | uint64 | Slot number before which the script is invalid. | |
| invalid_hereafter | uint64 | Slot number after which the script is invalid. |
NativeScriptList
Represents a list of native scripts.
| Field | Type | Label | Description |
|---|---|---|---|
| items | NativeScript | repeated | List of native scripts. |
NewCommitteeCredentials
The new committee credential are passed as a map where the key is the committee cold credential hash and the value is the expiration epoch for that credential
| Field | Type | Label | Description |
|---|---|---|---|
| committee_cold_credential | StakeCredential | ||
| expires_epoch | uint32 |
NewConstitutionAction
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId | ||
| constitution | Constitution | The Constitution proposed |
NoConfidenceAction
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId |
PParams
| Field | Type | Label | Description |
|---|---|---|---|
| coins_per_utxo_byte | BigInt | The number of coins per UTXO byte. | |
| max_tx_size | uint64 | The maximum transaction size. | |
| min_fee_coefficient | BigInt | The minimum fee coefficient. | |
| min_fee_constant | BigInt | The minimum fee constant. | |
| max_block_body_size | uint64 | The maximum block body size. | |
| max_block_header_size | uint64 | The maximum block header size. | |
| stake_key_deposit | BigInt | The stake key deposit. | |
| pool_deposit | BigInt | The pool deposit. | |
| pool_retirement_epoch_bound | uint64 | The pool retirement epoch bound. | |
| desired_number_of_pools | uint64 | The desired number of pools. | |
| pool_influence | RationalNumber | The pool influence. | |
| monetary_expansion | RationalNumber | The monetary expansion. | |
| treasury_expansion | RationalNumber | The treasury expansion. | |
| min_pool_cost | BigInt | The minimum pool cost. | |
| protocol_version | ProtocolVersion | The protocol version. | |
| max_value_size | uint64 | The maximum value size. | |
| collateral_percentage | uint64 | The collateral percentage. | |
| max_collateral_inputs | uint64 | The maximum collateral inputs. | |
| cost_models | CostModels | The cost models. | |
| prices | ExPrices | The prices. | |
| max_execution_units_per_transaction | ExUnits | The maximum execution units per transaction. | |
| max_execution_units_per_block | ExUnits | The maximum execution units per block. | |
| min_fee_script_ref_cost_per_byte | RationalNumber | The minimum fee per script reference byte. | |
| pool_voting_thresholds | VotingThresholds | The pool voting thresholds. | |
| drep_voting_thresholds | VotingThresholds | The drep voting thresholds. | |
| min_committee_size | uint32 | The minimum committee size. | |
| committee_term_limit | uint64 | The committee term limit. | |
| governance_action_validity_period | uint64 | The governance action validity period. | |
| governance_action_deposit | BigInt | The governance action deposit. | |
| drep_deposit | BigInt | The drep deposit. | |
| drep_inactivity_period | uint64 | The drep inactivity period. |
ParameterChangeAction
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId | ||
| protocol_param_update | PParams | The updates proposed | |
| policy_hash | bytes |
PlutusData
Represents a Plutus data item in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| constr | Constr | Constructor. | |
| map | PlutusDataMap | Map of Plutus data. | |
| big_int | BigInt | Big integer. | |
| bounded_bytes | bytes | Bounded bytes. | |
| array | PlutusDataArray | Array of Plutus data. |
PlutusDataArray
Represents an array of Plutus data in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| items | PlutusData | repeated | List of Plutus data items. |
PlutusDataMap
Represents a map of Plutus data in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| pairs | PlutusDataPair | repeated | List of key-value pairs. |
PlutusDataPair
Represents a key-value pair for Plutus data in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| key | PlutusData | Key of the pair. | |
| value | PlutusData | Value of the pair. |
PoolMetadata
Represents pool metadata in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| url | string | ||
| hash | bytes |
PoolRegistrationCert
Represents a pool registration certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| operator | bytes | Operator key hash. | |
| vrf_keyhash | bytes | VRF key hash. | |
| pledge | BigInt | Pledge amount. | |
| cost | BigInt | Pool cost. | |
| margin | RationalNumber | Pool margin. | |
| reward_account | bytes | Reward account. | |
| pool_owners | bytes | repeated | List of pool owner key hashes. |
| relays | Relay | repeated | List of relays. |
| pool_metadata | PoolMetadata | Pool metadata. |
PoolRegistrationPattern
Pattern for pool registration certificates
| Field | Type | Label | Description |
|---|---|---|---|
| operator | bytes | Match registrations by this operator | |
| pool_keyhash | bytes | Match registrations for this pool (derived from operator) |
PoolRetirementCert
Represents a pool retirement certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| pool_keyhash | bytes | Pool key hash. | |
| epoch | uint64 | Retirement epoch. |
PoolRetirementPattern
Pattern for pool retirement certificates
| Field | Type | Label | Description |
|---|---|---|---|
| pool_keyhash | bytes | Match retirements of this pool | |
| epoch | uint64 | Match retirements in this epoch |
PoolStakeShare
Per-pool stake share. Mirrors Ouroboros IndividualPoolStake.
| Field | Type | Label | Description |
|---|---|---|---|
| pool_keyhash | bytes | Pool key hash (pool id). | |
| stake_fraction | RationalNumber | Fraction of total active stake delegated to this pool. | |
| vrf_keyhash | bytes | Pool's VRF key hash, as reported by the node. |
PoolVotingThresholds
| Field | Type | Label | Description |
|---|---|---|---|
| motion_no_confidence | RationalNumber | ||
| committee_normal | RationalNumber | ||
| committee_no_confidence | RationalNumber | ||
| hard_fork_initiation | RationalNumber | ||
| pp_security_group | RationalNumber |
ProtocolConsts
| Field | Type | Label | Description |
|---|---|---|---|
| k | uint32 | ||
| protocol_magic | uint32 | ||
| vss_max_ttl | uint32 | ||
| vss_min_ttl | uint32 |
ProtocolVersion
| Field | Type | Label | Description |
|---|---|---|---|
| major | uint32 | ||
| minor | uint32 |
RationalNumber
Represents a rational number as a fraction.
| Field | Type | Label | Description |
|---|---|---|---|
| numerator | int32 | ||
| denominator | uint32 |
Redeemer
Redeemer information for a Plutus script.
| Field | Type | Label | Description |
|---|---|---|---|
| purpose | RedeemerPurpose | Purpose of the redeemer. | |
| payload | PlutusData | Plutus data associated with the redeemer. | |
| index | uint32 | Index of the redeemer. | |
| ex_units | ExUnits | Execution units consumed by the redeemer. | |
| original_cbor | bytes | Original cbor-encoded data as seen on-chain |
RegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| coin | BigInt |
RegDRepCert
| Field | Type | Label | Description |
|---|---|---|---|
| drep_credential | StakeCredential | ||
| coin | BigInt | ||
| anchor | Anchor |
Relay
Represents a relay in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| ip_v4 | bytes | ||
| ip_v6 | bytes | ||
| dns_name | string | ||
| port | uint32 |
ResignCommitteeColdCert
| Field | Type | Label | Description |
|---|---|---|---|
| committee_cold_credential | StakeCredential | ||
| anchor | Anchor |
Script
Represents a script in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| native | NativeScript | Native script. | |
| plutus_v1 | bytes | Plutus V1 script. | |
| plutus_v2 | bytes | Plutus V2 script. | |
| plutus_v3 | bytes | Plutus V3 script. | |
| plutus_v4 | bytes | Plutus V4 script. |
ScriptNOfK
Represents a "k out of n" native script.
| Field | Type | Label | Description |
|---|---|---|---|
| k | uint32 | The number of required satisfied scripts. | |
| scripts | NativeScript | repeated | List of native scripts. |
SoftforkRule
| Field | Type | Label | Description |
|---|---|---|---|
| init_thd | string | ||
| min_thd | string | ||
| thd_decrement | string |
StakeCredential
Represents a stake credential in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| addr_key_hash | bytes | Address key hash. | |
| script_hash | bytes | Script hash. |
StakeDelegationCert
Represents a stake delegation certificate in Cardano.
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | Stake credential. | |
| pool_keyhash | bytes | Pool key hash. |
StakeDelegationPattern
Pattern for stake delegation certificates
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | Match delegations from this credential | |
| pool_keyhash | bytes | Match delegations to this pool |
StakePoolDistribution
Result of a stake pool distribution query.
| Field | Type | Label | Description |
|---|---|---|---|
| pools | PoolStakeShare | repeated | One entry per pool present in the snapshot. |
StakeRegDelegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| pool_keyhash | bytes | ||
| coin | BigInt |
StakeVoteDelegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| pool_keyhash | bytes | ||
| drep | DRep |
StakeVoteRegDelegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| pool_keyhash | bytes | ||
| drep | DRep | ||
| coin | BigInt |
StateData
Envelope of a Cardano ledger-state query result.
| Field | Type | Label | Description |
|---|---|---|---|
| stake_pool_distribution | StakePoolDistribution | Result of a stake pool distribution query. |
StateQuery
Envelope of a Cardano ledger-state query.
| Field | Type | Label | Description |
|---|---|---|---|
| stake_pool_distribution | GetStakePoolDistribution | Active stake distribution across pools. |
TreasuryWithdrawalsAction
| Field | Type | Label | Description |
|---|---|---|---|
| withdrawals | WithdrawalAmount | repeated | A list of the withdrawals to make |
| policy_hash | bytes |
Tx
Represents a transaction in the Cardano blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| inputs | TxInput | repeated | List of transaction inputs |
| outputs | TxOutput | repeated | List of transaction outputs |
| certificates | Certificate | repeated | List of certificates |
| withdrawals | Withdrawal | repeated | List of withdrawals |
| mint | Multiasset | repeated | List of minted custom assets |
| reference_inputs | TxInput | repeated | List of reference inputs |
| witnesses | WitnessSet | Witnesses that validte the transaction | |
| collateral | Collateral | Collateral details in case of failed transaction | |
| fee | BigInt | Transaction fee in ADA | |
| validity | TxValidity | Validity interval of the transaction | |
| successful | bool | Flag indicating whether the transaction was successful | |
| auxiliary | AuxData | Auxiliary data not directly tied to the validation process | |
| hash | bytes | Hash of the transaction that serves as main identifier | |
| proposals | GovernanceActionProposal | repeated | List of governance actions proposed |
| votes | VoterVotes | repeated | List of voters and their corresponding votes cast in this transaction |
TxEval
Result of evaluating a transaction against the current ledger state.
| Field | Type | Label | Description |
|---|---|---|---|
| fee | BigInt | Computed minimum fee for the transaction. | |
| ex_units | ExUnits | Total execution units consumed across all redeemers. | |
| errors | EvalReport | repeated | Per-redeemer script execution errors. |
| traces | EvalReport | repeated | Per-redeemer script execution traces. |
| redeemers | Redeemer | repeated | Redeemers with evaluated execution units. |
TxFeePolicy
| Field | Type | Label | Description |
|---|---|---|---|
| multiplier | string | ||
| summand | string |
TxInput
Represents a transaction input in the Cardano blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| tx_hash | bytes | Hash of the previous transaction. | |
| output_index | uint32 | Index of the output in the previous transaction. | |
| as_output | TxOutput | Content of the input represented as output of the related transaction | |
| redeemer | Redeemer | optional | Redeemer for the Plutus script. |
TxOutput
Represents a transaction output in the Cardano blockchain.
| Field | Type | Label | Description |
|---|---|---|---|
| address | bytes | Address receiving the output. | |
| coin | BigInt | Amount of ADA in the output. | |
| assets | Multiasset | repeated | Additional native (non-ADA) assets in the output. |
| datum | Datum | optional | Plutus data associated with the output. |
| script | Script | optional | Script associated with the output. |
| original_cbor | bytes | optional | Original cbor-encoded output as seen on-chain. |
TxOutputPattern
Pattern of a tx output that can be used to evaluate matching predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| address | AddressPattern | optional | Match any address in the output that exhibits this pattern. |
| asset | AssetPattern | optional | Match any asset in the output that exhibits this pattern. |
TxPattern
Pattern of a Tx that can be used to evaluate matching predicates.
| Field | Type | Label | Description |
|---|---|---|---|
| consumes | TxOutputPattern | Match any input that exhibits this pattern. | |
| produces | TxOutputPattern | Match any output that exhibits this pattern. | |
| has_address | AddressPattern | Match any address (inputs, outputs, collateral, etc) that exhibits this pattern. | |
| moves_asset | AssetPattern | Match any asset that exhibits this pattern. | |
| mints_asset | AssetPattern | Match any tx that either mint or burn the the asset pattern. | |
| has_certificate | CertificatePattern | Match any transaction that includes this certificate pattern. |
TxValidity
Represents the validity interval of a transaction.
| Field | Type | Label | Description |
|---|---|---|---|
| start | uint64 | Start of the validity interval. | |
| ttl | uint64 | End of the validity interval (TTL: Time to Live). |
UnRegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| coin | BigInt |
UnRegDRepCert
| Field | Type | Label | Description |
|---|---|---|---|
| drep_credential | StakeCredential | ||
| coin | BigInt |
UpdateCommitteeAction
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId | ||
| remove_committee_credentials | StakeCredential | repeated | Committee members to remove (if any) |
| new_committee_credentials | NewCommitteeCredentials | repeated | The new committee members |
| new_committee_threshold | RationalNumber | The required threshold for the committee |
UpdateDRepCert
| Field | Type | Label | Description |
|---|---|---|---|
| drep_credential | StakeCredential | ||
| anchor | Anchor |
VKeyWitness
Represents a VKey witness used to sign a transaction.
| Field | Type | Label | Description |
|---|---|---|---|
| vkey | bytes | Verification key. | |
| signature | bytes | Signature generated using the associated private key. |
VoteDelegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| drep | DRep |
VoteRegDelegCert
| Field | Type | Label | Description |
|---|---|---|---|
| stake_credential | StakeCredential | ||
| drep | DRep | ||
| coin | BigInt |
VoterVotes
Groups a voter with all votes they cast in the transaction. SPOs can only identify via pool key hash; DReps and CC members may use key or script hash.
| Field | Type | Label | Description |
|---|---|---|---|
| constitutional_committee | StakeCredential | Constitutional Committee member. | |
| drep | StakeCredential | Delegated Representative. | |
| spo | bytes | Stake Pool Operator (pool key hash). | |
| votes | VotingProcedure | repeated | Votes cast by this voter. |
VotingProcedure
A single cast vote on a governance action.
| Field | Type | Label | Description |
|---|---|---|---|
| gov_action_id | GovernanceActionId | ID of the governance action being voted on. | |
| vote | Vote | The vote cast. | |
| anchor | Anchor | optional | Optional anchor for voter rationale. |
VotingThresholds
| Field | Type | Label | Description |
|---|---|---|---|
| thresholds | RationalNumber | repeated |
VssCert
| Field | Type | Label | Description |
|---|---|---|---|
| expiry_epoch | uint32 | ||
| signature | string | ||
| signing_key | string | ||
| vss_key | string |
Withdrawal
Represents a withdrawal from a reward account.
| Field | Type | Label | Description |
|---|---|---|---|
| reward_account | bytes | Address of the reward account. | |
| coin | BigInt | Amount of ADA withdrawn. | |
| redeemer | Redeemer | Redeemer for the Plutus script. |
WithdrawalAmount
| Field | Type | Label | Description |
|---|---|---|---|
| reward_account | bytes | ||
| coin | BigInt |
WitnessSet
Represents a set of witnesses that validate a transaction
| Field | Type | Label | Description |
|---|---|---|---|
| vkeywitness | VKeyWitness | repeated | List of VKey witnesses. |
| script | Script | repeated | List of scripts. |
| plutus_datums | PlutusData | repeated | List of Plutus data elements associated with the transaction. |
| redeemers | Redeemer | repeated | List of redeemers |
| bootstrapWitnesses | BootstrapWitness | repeated | List of bootstrap witnesses |
MirSource
| Name | Number | Description |
|---|---|---|
| MIR_SOURCE_UNSPECIFIED | 0 | |
| MIR_SOURCE_RESERVES | 1 | |
| MIR_SOURCE_TREASURY | 2 |
RedeemerPurpose
Purpose of the redeemer in a transaction.
| Name | Number | Description |
|---|---|---|
| REDEEMER_PURPOSE_UNSPECIFIED | 0 | |
| REDEEMER_PURPOSE_SPEND | 1 | |
| REDEEMER_PURPOSE_MINT | 2 | |
| REDEEMER_PURPOSE_CERT | 3 | |
| REDEEMER_PURPOSE_REWARD | 4 | |
| REDEEMER_PURPOSE_VOTE | 5 | |
| REDEEMER_PURPOSE_PROPOSE | 6 |
Vote
Valid vote choices for a governance action (CIP-1694). On-chain CBOR mapping: No=0, Yes=1, Abstain=2.
| Name | Number | Description |
|---|---|---|
| VOTE_UNSPECIFIED | 0 | |
| VOTE_NO | 1 | |
| VOTE_YES | 2 | |
| VOTE_ABSTAIN | 3 |