Cardano Module

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.

FieldTypeLabelDescription
exact_addressbytesoptionalThe address should match this exact address value.
payment_partbytesoptionalThe payment part of the address should match this value.
delegation_partbytesoptionalThe delegation part of the address should match this value.

Anchor

FieldTypeLabelDescription
urlstring
content_hashbytes

Asset

Represents a custom asset in the Cardano blockchain.

FieldTypeLabelDescription
namebytesName of the custom asset.
quantityBigIntQuantity 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.

FieldTypeLabelDescription
policy_idbytesoptionalThe asset should belong to this policy id
asset_namebytesoptionalThe asset should present this name

AuthCommitteeHotCert

FieldTypeLabelDescription
committee_cold_credentialStakeCredential
committee_hot_credentialStakeCredential

AuxData

Auxiliary data not directly tied to the validation process

FieldTypeLabelDescription
metadataMetadatarepeatedList of auxiliary metadata elements.
scriptsScriptrepeatedList 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.

FieldTypeLabelDescription
intint64Stores value fitting within int64 range
big_u_intbytesStores unsigned value exceeding int64 range
big_n_intbytesStores negative value n exceeding int64 range as -1 - n

Block

Represents a complete block, including header and body.

FieldTypeLabelDescription
headerBlockHeaderBlock header.
bodyBlockBodyBlock body.
timestampuint64Block ms timestamp

BlockBody

Contains the transaction data for a block.

FieldTypeLabelDescription
txTxrepeatedList of transactions.

BlockHeader

Contains the header information for a block.

FieldTypeLabelDescription
slotuint64Slot number.
hashbytesBlock hash.
heightuint64Block height.

BlockVersionData

FieldTypeLabelDescription
script_versionuint32
slot_durationstring
max_block_sizestring
max_header_sizestring
max_tx_sizestring
max_proposal_sizestring
mpc_thdstring
heavy_del_thdstring
update_vote_thdstring
update_proposal_thdstring
update_implicitstring
softfork_ruleSoftforkRule
tx_fee_policyTxFeePolicy
unlock_stake_epochstring

BootstrapWitness

Represents bootstrap keys from Byron era

FieldTypeLabelDescription
vkeybytesVerification key.
signaturebytesSignature generated using the associated private key.
chain_codebytes32 bytes of chain code
attributesbyteskey attributes

Certificate

Represents a certificate in Cardano.

FieldTypeLabelDescription
stake_registrationStakeCredentialStake registration certificate.
stake_deregistrationStakeCredentialStake deregistration certificate.
stake_delegationStakeDelegationCertStake delegation certificate.
pool_registrationPoolRegistrationCertPool registration certificate.
pool_retirementPoolRetirementCertPool retirement certificate.
genesis_key_delegationGenesisKeyDelegationCertGenesis key delegation certificate.
mir_certMirCertMove instantaneous rewards certificate.
reg_certRegCertRegistration certificate.
unreg_certUnRegCertUnregistration certificate.
vote_deleg_certVoteDelegCertVote delegation certificate.
stake_vote_deleg_certStakeVoteDelegCertStake and vote delegation certificate.
stake_reg_deleg_certStakeRegDelegCertStake registration and delegation certificate.
vote_reg_deleg_certVoteRegDelegCertVote registration and delegation certificate.
stake_vote_reg_deleg_certStakeVoteRegDelegCertStake and vote registration and delegation certificate.
auth_committee_hot_certAuthCommitteeHotCertAuthorize committee hot key certificate.
resign_committee_cold_certResignCommitteeColdCertResign committee cold key certificate.
reg_drep_certRegDRepCertRegister DRep certificate.
unreg_drep_certUnRegDRepCertUnregister DRep certificate.
update_drep_certUpdateDRepCertUpdate DRep certificate.
redeemerRedeemerRedeemer for the Plutus script.

CertificatePattern

Pattern of a certificate that can be used to evaluate matching predicates.

FieldTypeLabelDescription
stake_registrationStakeCredentialMatch stake registration for this credential
stake_deregistrationStakeCredentialMatch stake deregistration for this credential
stake_delegationStakeDelegationPatternMatch stake delegation pattern
pool_registrationPoolRegistrationPatternMatch pool registration pattern
pool_retirementPoolRetirementPatternMatch pool retirement pattern
any_stake_credentialbytesMatch any certificate involving this stake credential
any_pool_keyhashbytesMatch any certificate involving this pool
any_drepbytesMatch any certificate involving this DRep

Collateral

Represents the collateral information for a transaction.

FieldTypeLabelDescription
collateralTxInputrepeatedCollateral inputs for the transaction.
collateral_returnTxOutputCollateral return in case of script failure.
total_collateralBigIntTotal amount of collateral.

Committee

FieldTypeLabelDescription
membersCommittee.MembersEntryrepeated
thresholdRationalNumber

Committee.MembersEntry

FieldTypeLabelDescription
keystring
valueuint64

Constitution

FieldTypeLabelDescription
anchorAnchorAnchor to the new document
hashbytesHash of the document

Constr

Represents a constructor for Plutus data in Cardano.

FieldTypeLabelDescription
taguint32
any_constructoruint64
fieldsPlutusDatarepeated

CostModel

FieldTypeLabelDescription
valuesint64repeated

CostModelMap

FieldTypeLabelDescription
plutus_v1CostModel
plutus_v2CostModel
plutus_v3CostModel
plutus_v4CostModel

CostModels

FieldTypeLabelDescription
plutus_v1CostModel
plutus_v2CostModel
plutus_v3CostModel
plutus_v4CostModel

DRep

FieldTypeLabelDescription
addr_key_hashbytesAddress key hash
script_hashbytesScript hash
abstainboolAbstain
no_confidenceboolNo confidence

DRepVotingThresholds

FieldTypeLabelDescription
motion_no_confidenceRationalNumber
committee_normalRationalNumber
committee_no_confidenceRationalNumber
update_to_constitutionRationalNumber
hard_fork_initiationRationalNumber
pp_network_groupRationalNumber
pp_economic_groupRationalNumber
pp_technical_groupRationalNumber
pp_gov_groupRationalNumber
treasury_withdrawalRationalNumber

Datum

FieldTypeLabelDescription
hashbytesHash of this datum as seen on-chain
payloadPlutusDataoptionalParsed Plutus data payload
original_cborbytesoptionalOriginal cbor-encoded data as seen on-chain

EraBoundary

FieldTypeLabelDescription
timeuint64ms timestamp
slotuint64absolute slot number of the first block of this era
epochuint64first epoch for this era

EraSummaries

FieldTypeLabelDescription
summariesEraSummaryrepeated

EraSummary

FieldTypeLabelDescription
namestringname of the era (ex: "shelley")
startEraBoundarystart of this era
endEraBoundaryend of this era (if the era has a well-defined ending)
protocol_paramsPParamsprotocol 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.

FieldTypeLabelDescription
msgstringHuman-readable message.
purposeRedeemerPurposePurpose of the redeemer that produced this entry.
indexuint320-based index of the redeemer within its purpose.

ExPrices

FieldTypeLabelDescription
stepsRationalNumber
memoryRationalNumber

ExUnits

FieldTypeLabelDescription
stepsuint64
memoryuint64

ExtraEntropy

FieldTypeLabelDescription
tagstring

GenDelegs

FieldTypeLabelDescription
delegatestring
vrfstring

Genesis

Unified Genesis configuration containing all parameters from all eras

FieldTypeLabelDescription
avvm_distrGenesis.AvvmDistrEntryrepeated============ Byron Era Fields ============
block_version_dataBlockVersionData
fts_seedstring
protocol_constsProtocolConsts
start_timeuint64
boot_stakeholdersGenesis.BootStakeholdersEntryrepeated
heavy_delegationGenesis.HeavyDelegationEntryrepeated
non_avvm_balancesGenesis.NonAvvmBalancesEntryrepeated
vss_certsGenesis.VssCertsEntryrepeated
active_slots_coeffRationalNumber============ Shelley Era Fields ============
epoch_lengthuint32
gen_delegsGenesis.GenDelegsEntryrepeated
initial_fundsGenesis.InitialFundsEntryrepeated
max_kes_evolutionsuint32
max_lovelace_supplyBigInt
network_idstring
network_magicuint32
protocol_paramsPParamsUsing PParams as it's a superset of all protocol parameters
security_paramuint32
slot_lengthuint32
slots_per_kes_perioduint32
system_startstring
update_quorumuint32
lovelace_per_utxo_wordBigInt============ Alonzo Era Fields ============
execution_pricesExPrices
max_tx_ex_unitsExUnits
max_block_ex_unitsExUnits
max_value_sizeuint32
collateral_percentageuint32
max_collateral_inputsuint32
cost_modelsCostModelMap
committeeCommittee============ Conway Era Fields ============
constitutionConstitution
committee_min_sizeuint64
committee_max_term_lengthuint64
gov_action_lifetimeuint64
gov_action_depositBigInt
drep_depositBigInt
drep_activityuint64
min_fee_ref_script_cost_per_byteRationalNumber
drep_voting_thresholdsDRepVotingThresholds
pool_voting_thresholdsPoolVotingThresholds

Genesis.AvvmDistrEntry

FieldTypeLabelDescription
keystring
valuestring

Genesis.BootStakeholdersEntry

FieldTypeLabelDescription
keystring
valueuint64

Genesis.GenDelegsEntry

FieldTypeLabelDescription
keystring
valueGenDelegs

Genesis.HeavyDelegationEntry

FieldTypeLabelDescription
keystring
valueHeavyDelegation

Genesis.InitialFundsEntry

FieldTypeLabelDescription
keystring
valueBigInt

Genesis.NonAvvmBalancesEntry

FieldTypeLabelDescription
keystring
valuestring

Genesis.VssCertsEntry

FieldTypeLabelDescription
keystring
valueVssCert

GenesisKeyDelegationCert

Represents a genesis key delegation certificate in Cardano.

FieldTypeLabelDescription
genesis_hashbytesGenesis hash.
genesis_delegate_hashbytesGenesis delegate hash.
vrf_keyhashbytesVRF key hash.

GetStakePoolDistribution

Stake pool distribution query. Mirrors Ouroboros GetPoolDistr / GetFilteredPoolDistr.

FieldTypeLabelDescription
pool_keyhashesbytesrepeatedIf non-empty, restrict the result to the listed pool key hashes. If empty, return the distribution for every pool.

GovernanceAction

Define a Governance Action

FieldTypeLabelDescription
parameter_change_actionParameterChangeActionChange on-chain parameters
hard_fork_initiation_actionHardForkInitiationActionInitiate a Hard Fork
treasury_withdrawals_actionTreasuryWithdrawalsActionWithdraw from the Treasury
no_confidence_actionNoConfidenceAction
update_committee_actionUpdateCommitteeActionUpdate the Constitution Committee
new_constitution_actionNewConstitutionActionReplace the Constitution
info_actionInfoActionInfo action

GovernanceActionId

FieldTypeLabelDescription
transaction_idbytes
governance_action_indexuint32

GovernanceActionProposal

Define a governance action proposal

FieldTypeLabelDescription
depositBigIntThe amount deposited for the governance action
reward_accountbytesThe reward account the deposit should be returned to
gov_actionGovernanceAction
anchorAnchor

HardForkInitiationAction

FieldTypeLabelDescription
gov_action_idGovernanceActionId
protocol_versionProtocolVersionThe protocol version to fork to

HeavyDelegation

FieldTypeLabelDescription
certstring
delegate_pkstring
issuer_pkstring
omegauint32

InfoAction

Metadata

FieldTypeLabelDescription
labeluint64
valueMetadatum

Metadatum

FieldTypeLabelDescription
intint64
bytesbytes
textstring
arrayMetadatumArray
mapMetadatumMap

MetadatumArray

FieldTypeLabelDescription
itemsMetadatumrepeated

MetadatumMap

FieldTypeLabelDescription
pairsMetadatumPairrepeated

MetadatumPair

FieldTypeLabelDescription
keyMetadatum
valueMetadatum

MirCert

Represents a move instantaneous reward certificate in Cardano.

FieldTypeLabelDescription
fromMirSource
toMirTargetrepeated
other_potuint64

MirTarget

FieldTypeLabelDescription
stake_credentialStakeCredential
delta_coinBigInt

Multiasset

Represents a multi-asset group in the Cardano blockchain.

FieldTypeLabelDescription
policy_idbytesPolicy ID governing the custom assets.
assetsAssetrepeatedList of custom assets.

NativeScript

Represents a native script in Cardano.

FieldTypeLabelDescription
script_pubkey_hashbytesScript based on an address key hash.
script_allNativeScriptListScript that requires all nested scripts to be satisfied.
script_anyNativeScriptListScript that requires any of the nested scripts to be satisfied.
script_n_of_kScriptNOfKScript that requires k out of n nested scripts to be satisfied.
invalid_beforeuint64Slot number before which the script is invalid.
invalid_hereafteruint64Slot number after which the script is invalid.

NativeScriptList

Represents a list of native scripts.

FieldTypeLabelDescription
itemsNativeScriptrepeatedList 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

FieldTypeLabelDescription
committee_cold_credentialStakeCredential
expires_epochuint32

NewConstitutionAction

FieldTypeLabelDescription
gov_action_idGovernanceActionId
constitutionConstitutionThe Constitution proposed

NoConfidenceAction

FieldTypeLabelDescription
gov_action_idGovernanceActionId

PParams

FieldTypeLabelDescription
coins_per_utxo_byteBigIntThe number of coins per UTXO byte.
max_tx_sizeuint64The maximum transaction size.
min_fee_coefficientBigIntThe minimum fee coefficient.
min_fee_constantBigIntThe minimum fee constant.
max_block_body_sizeuint64The maximum block body size.
max_block_header_sizeuint64The maximum block header size.
stake_key_depositBigIntThe stake key deposit.
pool_depositBigIntThe pool deposit.
pool_retirement_epoch_bounduint64The pool retirement epoch bound.
desired_number_of_poolsuint64The desired number of pools.
pool_influenceRationalNumberThe pool influence.
monetary_expansionRationalNumberThe monetary expansion.
treasury_expansionRationalNumberThe treasury expansion.
min_pool_costBigIntThe minimum pool cost.
protocol_versionProtocolVersionThe protocol version.
max_value_sizeuint64The maximum value size.
collateral_percentageuint64The collateral percentage.
max_collateral_inputsuint64The maximum collateral inputs.
cost_modelsCostModelsThe cost models.
pricesExPricesThe prices.
max_execution_units_per_transactionExUnitsThe maximum execution units per transaction.
max_execution_units_per_blockExUnitsThe maximum execution units per block.
min_fee_script_ref_cost_per_byteRationalNumberThe minimum fee per script reference byte.
pool_voting_thresholdsVotingThresholdsThe pool voting thresholds.
drep_voting_thresholdsVotingThresholdsThe drep voting thresholds.
min_committee_sizeuint32The minimum committee size.
committee_term_limituint64The committee term limit.
governance_action_validity_perioduint64The governance action validity period.
governance_action_depositBigIntThe governance action deposit.
drep_depositBigIntThe drep deposit.
drep_inactivity_perioduint64The drep inactivity period.

ParameterChangeAction

FieldTypeLabelDescription
gov_action_idGovernanceActionId
protocol_param_updatePParamsThe updates proposed
policy_hashbytes

PlutusData

Represents a Plutus data item in Cardano.

FieldTypeLabelDescription
constrConstrConstructor.
mapPlutusDataMapMap of Plutus data.
big_intBigIntBig integer.
bounded_bytesbytesBounded bytes.
arrayPlutusDataArrayArray of Plutus data.

PlutusDataArray

Represents an array of Plutus data in Cardano.

FieldTypeLabelDescription
itemsPlutusDatarepeatedList of Plutus data items.

PlutusDataMap

Represents a map of Plutus data in Cardano.

FieldTypeLabelDescription
pairsPlutusDataPairrepeatedList of key-value pairs.

PlutusDataPair

Represents a key-value pair for Plutus data in Cardano.

FieldTypeLabelDescription
keyPlutusDataKey of the pair.
valuePlutusDataValue of the pair.

PoolMetadata

Represents pool metadata in Cardano.

FieldTypeLabelDescription
urlstring
hashbytes

PoolRegistrationCert

Represents a pool registration certificate in Cardano.

FieldTypeLabelDescription
operatorbytesOperator key hash.
vrf_keyhashbytesVRF key hash.
pledgeBigIntPledge amount.
costBigIntPool cost.
marginRationalNumberPool margin.
reward_accountbytesReward account.
pool_ownersbytesrepeatedList of pool owner key hashes.
relaysRelayrepeatedList of relays.
pool_metadataPoolMetadataPool metadata.

PoolRegistrationPattern

Pattern for pool registration certificates

FieldTypeLabelDescription
operatorbytesMatch registrations by this operator
pool_keyhashbytesMatch registrations for this pool (derived from operator)

PoolRetirementCert

Represents a pool retirement certificate in Cardano.

FieldTypeLabelDescription
pool_keyhashbytesPool key hash.
epochuint64Retirement epoch.

PoolRetirementPattern

Pattern for pool retirement certificates

FieldTypeLabelDescription
pool_keyhashbytesMatch retirements of this pool
epochuint64Match retirements in this epoch

PoolStakeShare

Per-pool stake share. Mirrors Ouroboros IndividualPoolStake.

FieldTypeLabelDescription
pool_keyhashbytesPool key hash (pool id).
stake_fractionRationalNumberFraction of total active stake delegated to this pool.
vrf_keyhashbytesPool's VRF key hash, as reported by the node.

PoolVotingThresholds

FieldTypeLabelDescription
motion_no_confidenceRationalNumber
committee_normalRationalNumber
committee_no_confidenceRationalNumber
hard_fork_initiationRationalNumber
pp_security_groupRationalNumber

ProtocolConsts

FieldTypeLabelDescription
kuint32
protocol_magicuint32
vss_max_ttluint32
vss_min_ttluint32

ProtocolVersion

FieldTypeLabelDescription
majoruint32
minoruint32

RationalNumber

Represents a rational number as a fraction.

FieldTypeLabelDescription
numeratorint32
denominatoruint32

Redeemer

Redeemer information for a Plutus script.

FieldTypeLabelDescription
purposeRedeemerPurposePurpose of the redeemer.
payloadPlutusDataPlutus data associated with the redeemer.
indexuint32Index of the redeemer.
ex_unitsExUnitsExecution units consumed by the redeemer.
original_cborbytesOriginal cbor-encoded data as seen on-chain

RegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
coinBigInt

RegDRepCert

FieldTypeLabelDescription
drep_credentialStakeCredential
coinBigInt
anchorAnchor

Relay

Represents a relay in Cardano.

FieldTypeLabelDescription
ip_v4bytes
ip_v6bytes
dns_namestring
portuint32

ResignCommitteeColdCert

FieldTypeLabelDescription
committee_cold_credentialStakeCredential
anchorAnchor

Script

Represents a script in Cardano.

FieldTypeLabelDescription
nativeNativeScriptNative script.
plutus_v1bytesPlutus V1 script.
plutus_v2bytesPlutus V2 script.
plutus_v3bytesPlutus V3 script.
plutus_v4bytesPlutus V4 script.

ScriptNOfK

Represents a "k out of n" native script.

FieldTypeLabelDescription
kuint32The number of required satisfied scripts.
scriptsNativeScriptrepeatedList of native scripts.

SoftforkRule

FieldTypeLabelDescription
init_thdstring
min_thdstring
thd_decrementstring

StakeCredential

Represents a stake credential in Cardano.

FieldTypeLabelDescription
addr_key_hashbytesAddress key hash.
script_hashbytesScript hash.

StakeDelegationCert

Represents a stake delegation certificate in Cardano.

FieldTypeLabelDescription
stake_credentialStakeCredentialStake credential.
pool_keyhashbytesPool key hash.

StakeDelegationPattern

Pattern for stake delegation certificates

FieldTypeLabelDescription
stake_credentialStakeCredentialMatch delegations from this credential
pool_keyhashbytesMatch delegations to this pool

StakePoolDistribution

Result of a stake pool distribution query.

FieldTypeLabelDescription
poolsPoolStakeSharerepeatedOne entry per pool present in the snapshot.

StakeRegDelegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
pool_keyhashbytes
coinBigInt

StakeVoteDelegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
pool_keyhashbytes
drepDRep

StakeVoteRegDelegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
pool_keyhashbytes
drepDRep
coinBigInt

StateData

Envelope of a Cardano ledger-state query result.

FieldTypeLabelDescription
stake_pool_distributionStakePoolDistributionResult of a stake pool distribution query.

StateQuery

Envelope of a Cardano ledger-state query.

FieldTypeLabelDescription
stake_pool_distributionGetStakePoolDistributionActive stake distribution across pools.

TreasuryWithdrawalsAction

FieldTypeLabelDescription
withdrawalsWithdrawalAmountrepeatedA list of the withdrawals to make
policy_hashbytes

Tx

Represents a transaction in the Cardano blockchain.

FieldTypeLabelDescription
inputsTxInputrepeatedList of transaction inputs
outputsTxOutputrepeatedList of transaction outputs
certificatesCertificaterepeatedList of certificates
withdrawalsWithdrawalrepeatedList of withdrawals
mintMultiassetrepeatedList of minted custom assets
reference_inputsTxInputrepeatedList of reference inputs
witnessesWitnessSetWitnesses that validte the transaction
collateralCollateralCollateral details in case of failed transaction
feeBigIntTransaction fee in ADA
validityTxValidityValidity interval of the transaction
successfulboolFlag indicating whether the transaction was successful
auxiliaryAuxDataAuxiliary data not directly tied to the validation process
hashbytesHash of the transaction that serves as main identifier
proposalsGovernanceActionProposalrepeatedList of governance actions proposed
votesVoterVotesrepeatedList of voters and their corresponding votes cast in this transaction

TxEval

Result of evaluating a transaction against the current ledger state.

FieldTypeLabelDescription
feeBigIntComputed minimum fee for the transaction.
ex_unitsExUnitsTotal execution units consumed across all redeemers.
errorsEvalReportrepeatedPer-redeemer script execution errors.
tracesEvalReportrepeatedPer-redeemer script execution traces.
redeemersRedeemerrepeatedRedeemers with evaluated execution units.

TxFeePolicy

FieldTypeLabelDescription
multiplierstring
summandstring

TxInput

Represents a transaction input in the Cardano blockchain.

FieldTypeLabelDescription
tx_hashbytesHash of the previous transaction.
output_indexuint32Index of the output in the previous transaction.
as_outputTxOutputContent of the input represented as output of the related transaction
redeemerRedeemeroptionalRedeemer for the Plutus script.

TxOutput

Represents a transaction output in the Cardano blockchain.

FieldTypeLabelDescription
addressbytesAddress receiving the output.
coinBigIntAmount of ADA in the output.
assetsMultiassetrepeatedAdditional native (non-ADA) assets in the output.
datumDatumoptionalPlutus data associated with the output.
scriptScriptoptionalScript associated with the output.
original_cborbytesoptionalOriginal cbor-encoded output as seen on-chain.

TxOutputPattern

Pattern of a tx output that can be used to evaluate matching predicates.

FieldTypeLabelDescription
addressAddressPatternoptionalMatch any address in the output that exhibits this pattern.
assetAssetPatternoptionalMatch any asset in the output that exhibits this pattern.

TxPattern

Pattern of a Tx that can be used to evaluate matching predicates.

FieldTypeLabelDescription
consumesTxOutputPatternMatch any input that exhibits this pattern.
producesTxOutputPatternMatch any output that exhibits this pattern.
has_addressAddressPatternMatch any address (inputs, outputs, collateral, etc) that exhibits this pattern.
moves_assetAssetPatternMatch any asset that exhibits this pattern.
mints_assetAssetPatternMatch any tx that either mint or burn the the asset pattern.
has_certificateCertificatePatternMatch any transaction that includes this certificate pattern.

TxValidity

Represents the validity interval of a transaction.

FieldTypeLabelDescription
startuint64Start of the validity interval.
ttluint64End of the validity interval (TTL: Time to Live).

UnRegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
coinBigInt

UnRegDRepCert

FieldTypeLabelDescription
drep_credentialStakeCredential
coinBigInt

UpdateCommitteeAction

FieldTypeLabelDescription
gov_action_idGovernanceActionId
remove_committee_credentialsStakeCredentialrepeatedCommittee members to remove (if any)
new_committee_credentialsNewCommitteeCredentialsrepeatedThe new committee members
new_committee_thresholdRationalNumberThe required threshold for the committee

UpdateDRepCert

FieldTypeLabelDescription
drep_credentialStakeCredential
anchorAnchor

VKeyWitness

Represents a VKey witness used to sign a transaction.

FieldTypeLabelDescription
vkeybytesVerification key.
signaturebytesSignature generated using the associated private key.

VoteDelegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
drepDRep

VoteRegDelegCert

FieldTypeLabelDescription
stake_credentialStakeCredential
drepDRep
coinBigInt

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.

FieldTypeLabelDescription
constitutional_committeeStakeCredentialConstitutional Committee member.
drepStakeCredentialDelegated Representative.
spobytesStake Pool Operator (pool key hash).
votesVotingProcedurerepeatedVotes cast by this voter.

VotingProcedure

A single cast vote on a governance action.

FieldTypeLabelDescription
gov_action_idGovernanceActionIdID of the governance action being voted on.
voteVoteThe vote cast.
anchorAnchoroptionalOptional anchor for voter rationale.

VotingThresholds

FieldTypeLabelDescription
thresholdsRationalNumberrepeated

VssCert

FieldTypeLabelDescription
expiry_epochuint32
signaturestring
signing_keystring
vss_keystring

Withdrawal

Represents a withdrawal from a reward account.

FieldTypeLabelDescription
reward_accountbytesAddress of the reward account.
coinBigIntAmount of ADA withdrawn.
redeemerRedeemerRedeemer for the Plutus script.

WithdrawalAmount

FieldTypeLabelDescription
reward_accountbytes
coinBigInt

WitnessSet

Represents a set of witnesses that validate a transaction

FieldTypeLabelDescription
vkeywitnessVKeyWitnessrepeatedList of VKey witnesses.
scriptScriptrepeatedList of scripts.
plutus_datumsPlutusDatarepeatedList of Plutus data elements associated with the transaction.
redeemersRedeemerrepeatedList of redeemers
bootstrapWitnessesBootstrapWitnessrepeatedList of bootstrap witnesses

MirSource

NameNumberDescription
MIR_SOURCE_UNSPECIFIED0
MIR_SOURCE_RESERVES1
MIR_SOURCE_TREASURY2

RedeemerPurpose

Purpose of the redeemer in a transaction.

NameNumberDescription
REDEEMER_PURPOSE_UNSPECIFIED0
REDEEMER_PURPOSE_SPEND1
REDEEMER_PURPOSE_MINT2
REDEEMER_PURPOSE_CERT3
REDEEMER_PURPOSE_REWARD4
REDEEMER_PURPOSE_VOTE5
REDEEMER_PURPOSE_PROPOSE6

Vote

Valid vote choices for a governance action (CIP-1694). On-chain CBOR mapping: No=0, Yes=1, Abstain=2.

NameNumberDescription
VOTE_UNSPECIFIED0
VOTE_NO1
VOTE_YES2
VOTE_ABSTAIN3