This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Index

Interfaces

Type aliases

Type aliases

AcquireFailureDetails

AcquireFailureDetails: "pointTooOld" | "pointNotOnChain"

Address

Address: string

A Cardano address (either legacy format or new format).

AddressAttributes

AddressAttributes: string

Extra attributes carried by Byron addresses (network magic and/or HD payload).

AssetQuantity

AssetQuantity: bigint

A number of asset, can be negative went burning assets.

Base16

Base16: string

A Blake2b 28-byte digest of a verification key or a script.

Bech32

Bech32: string

A Blake2b 28-byte digest of a verification key or script.

Block

A Cardano Block, which can take different forms depending on the era.

BlockByron

A block in the Byron era. Most blocks are stanard blocks, but once at the beginning of each era is an additional epoch boundary block (a.k.a. EBB)

BlockNo

BlockNo: number

A block number, the i-th block to be minted is number i.

BlockNoOrOrigin

BlockNoOrOrigin: BlockNo | Origin

BlockSize

BlockSize: number

The size of the block in bytes.

Certificate

ChainCode

ChainCode: string

An Ed25519-BIP32 chain-code for key deriviation.

Datum

Datum: string

DigestBlake2BAuxiliaryDataBody

DigestBlake2BAuxiliaryDataBody: string

A Blake2b 32-byte digest of an 'AuxiliaryDataBody', serialised as CBOR.

DigestBlake2BBlockBody

DigestBlake2BBlockBody: string

A Blake2b 32-byte digest of an era-independent block body.

DigestBlake2BBlockByronBodyDlgPayload

DigestBlake2BBlockByronBodyDlgPayload: string

A Blake2b 32-byte digest of a Byron delegation payload, CBOR-encoded.

DigestBlake2BBlockByronBodyTxPayloadWitness

DigestBlake2BBlockByronBodyTxPayloadWitness: string

A Blake2b 32-byte digest of a Byron transaction witness set, CBOR-encoded.

DigestBlake2BBlockByronBodyUpdatePayload

DigestBlake2BBlockByronBodyUpdatePayload: string

A Blake2b 32-byte digest of a Byron update payload, CBOR-encoded.

DigestBlake2BBlockHeader

DigestBlake2BBlockHeader: string | "genesis"

DigestBlake2BCredential

DigestBlake2BCredential: string

A Blake2b 28-byte digest of a verification key or a script.

DigestBlake2BDatum

DigestBlake2BDatum: string

A Blake2b 32-byte digest of a serialized datum, CBOR-encoded.

DigestBlake2BMerkleRoot

DigestBlake2BMerkleRoot: string

A Blake2b 32-byte digest of a Merkle tree (or all block's transactions) root hash.

DigestBlake2BNonce

DigestBlake2BNonce: string

A Blake2b 32-byte digest of some arbitrary to make a nonce.

DigestBlake2BPoolMetadata

DigestBlake2BPoolMetadata: string

A Blake2b 32-byte digest of stake pool (canonical) JSON metadata.

DigestBlake2BScript

DigestBlake2BScript: string

A Blake2b 32-byte digest of a phase-1 or phase-2 script, CBOR-encoded.

DigestBlake2BScriptIntegrity

DigestBlake2BScriptIntegrity: string

A Blake2b 32-byte digest of a script-integrity hash (i.e redeemers, datums and cost model, CBOR-encoded).

DigestBlake2BVerificationKey

DigestBlake2BVerificationKey: string

A Blake2b 28-byte digest of an Ed25519 verification key.

DigestBlake2BVrfVerificationKey

DigestBlake2BVrfVerificationKey: string

A Blake2b 32-byte digest of a VRF verification key.

Epoch

Epoch: number

An epoch number or length.

Era

Era: "Byron" | "Shelley" | "Allegra" | "Mary" | "Alonzo" | "Babbage"

GenesisVerificationKey

GenesisVerificationKey: string

An Ed25519-BIP32 Byron genesis delegate verification key with chain-code.

GetBlockHeight

GetBlockHeight: "blockHeight"

GetChainTip

GetChainTip: "chainTip"

GetCurrentEpoch

GetCurrentEpoch: "currentEpoch"

GetCurrentProtocolParameters

GetCurrentProtocolParameters: "currentProtocolParameters"

GetEraStart

GetEraStart: "eraStart"

GetEraSummaries

GetEraSummaries: "eraSummaries"

GetLedgerTip

GetLedgerTip: "ledgerTip"

GetPoolIds

GetPoolIds: "poolIds"

GetPoolsRanking

GetPoolsRanking: "poolsRanking"

GetProposedProtocolParameters

GetProposedProtocolParameters: "proposedProtocolParameters"

GetRewardsProvenance

GetRewardsProvenance: "rewardsProvenance'"

GetRewardsProvenanceDeprecated

GetRewardsProvenanceDeprecated: "rewardsProvenance"

GetStakeDistribution

GetStakeDistribution: "stakeDistribution"

GetSystemStart

GetSystemStart: "systemStart"

GetUtxo

GetUtxo: "utxo"

Int64

Int64: number

InvalidEntity

InvalidEntity: object | object | object

IssuerSignature

IssuerSignature: string

Signature proving a block was issued by a given issuer VRF key.

IssuerVrfVerificationKey

IssuerVrfVerificationKey: string

A key identifying a block issuer.

KesVerificationKey

KesVerificationKey: string

Language

Language: "plutus:v1" | "plutus:v2"

Lovelace

Lovelace: bigint

A number of lovelace, possibly large when summed up.

LovelaceDelta

LovelaceDelta: number

An amount, possibly negative, in Lovelace (1e6 Lovelace = 1 Ada).

Metadatum

Metadatum: Int | String | Bytes | List | Map

Network

Network: "mainnet" | "testnet"

A network target, as defined since the Shelley era.

NetworkMagic

NetworkMagic: number

A magic number for telling networks apart. (e.g. 764824073)

Neutral

Neutral: "neutral"

Nonce

Null

Null: null

NullableRatio

NullableRatio: Ratio | Null

NullableUInt64

NullableUInt64: UInt64 | Null

Origin

Origin: "origin"

The origin of the blockchain. This point is special in the sense that it doesn't point to any existing slots, but is preceding any existing other point.

PointOrOrigin

PointOrOrigin: Point | Origin

PoolId

PoolId: string

A Blake2b 32-byte digest of a pool's verification key.

ProtocolMagicId

ProtocolMagicId: number

QueryUnavailableInCurrentEra

QueryUnavailableInCurrentEra: "QueryUnavailableInCurrentEra"

The requested query is not available in the current node era. It could be that the node is not fully synced.

Ratio

Ratio: string

A ratio of two integers, to express exact fractions.

RedeemerData

RedeemerData: string

Plutus data, CBOR-serialised.

RedeemerPointer

RedeemerPointer: string

RelativeTime

RelativeTime: number

A time in seconds relative to another one (typically, system start or era start). Starting from v5.5.4, this can be a floating number. Before v5.5.4, the floating value would be rounded to the nearest second.

Relay

Relay: ByAddress | ByName

RewardAccount

RewardAccount: string

A reward account, also known as 'stake address'.

RewardPot

RewardPot: "reserves" | "treasury"

Source of rewards as defined by the protocol parameters.

SafeZone

SafeZone: number

Number of slots from the tip of the ledger in which it is guaranteed that no hard fork can take place. This should be (at least) the number of slots in which we are guaranteed to have k blocks.

Script

ScriptFailure

Errors which may occur when evaluating an on-chain script.

ScriptNative

A phase-1 monetary script. Timelocks constraints are only supported since Allegra.

ScriptPlutus

ScriptPlutus: string

A phase-2 Plutus script; or said differently, a serialized Plutus-core program.

ScriptPurpose

ScriptPurpose: Spend | Mint | Certificate1 | Withdrawal

Signature

Signature: string

A signature coming from an Ed25519 or Ed25519-BIP32 signing key.

Slot

Slot: number

An absolute slot number.

SlotLength

SlotLength: number

A slot length, in seconds. Starting from v5.5.4, this can be a floating number. Before v5.5.4, the floating value would be rounded to the nearest second.

StakeAddress

StakeAddress: string

A stake address (a.k.a reward account)

StakeCredential

StakeCredential: Base16 | Bech32 | StakeAddress

SubmitTxError

SubmitTxError: (EraMismatch | InvalidWitnesses | MissingVkWitnesses | MissingScriptWitnesses | ScriptWitnessNotValidating | InsufficientGenesisSignatures | MissingTxMetadata | MissingTxMetadataHash | TxMetadataHashMismatch | BadInputs | ExpiredUtxo | OutsideOfValidityInterval | TxTooLarge | MissingAtLeastOneInputUtxo | InvalidMetadata | FeeTooSmall | ValueNotConserved | NetworkMismatch | OutputTooSmall | TooManyAssetsInOutput | AddressAttributesTooLarge | TriesToForgeAda | DelegateNotRegistered | UnknownOrIncompleteWithdrawals | StakePoolNotRegistered | WrongRetirementEpoch | WrongPoolCertificate | StakeKeyAlreadyRegistered | PoolCostTooSmall | PoolMetadataHashTooBig | StakeKeyNotRegistered | RewardAccountNotExisting | RewardAccountNotEmpty | WrongCertificateType | UnknownGenesisKey | AlreadyDelegating | InsufficientFundsForMir | TooLateForMir | MirTransferNotCurrentlyAllowed | MirNegativeTransferNotCurrentlyAllowed | MirProducesNegativeUpdate | DuplicateGenesisVrf | NonGenesisVoters | UpdateWrongEpoch | ProtocolVersionCannotFollow | MissingRequiredRedeemers | MissingRequiredDatums | UnspendableDatums | ExtraDataMismatch | MissingRequiredSignatures | UnspendableScriptInputs | ExtraRedeemers | MissingDatumHashesForInputs | MissingCollateralInputs | CollateralTooSmall | CollateralIsScript | CollateralHasNonAdaAssets | TooManyCollateralInputs | ExecutionUnitsTooLarge | OutsideForecast | ValidationTagMismatch | CollectErrors | ExtraScriptWitnesses | MirNegativeTransfer | TotalCollateralMismatch | MalformedReferenceScripts | MalformedScriptWitnesses)[]

TipOrOrigin

TipOrOrigin: Tip | Origin

TxId

TxId: string

A Blake2b 32-byte digest of a transaction body, CBOR-encoded.

TxWitness

UInt32

UInt32: number

UInt64

UInt64: number

UInt8

UInt8: number

UpdateAlonzo

UpdateAlonzo: Null | UpdateProposalAlonzo

UpdateBabbage

UpdateBabbage: Null | UpdateProposalBabbage

UpdateShelley

UpdateShelley: Null | UpdateProposalShelley

UtcTime

UtcTime: string

Utxo

Utxo: [TxIn, TxOut][]

VerificationKey

VerificationKey: string

An Ed25519 verification key.

VotingPeriod

VotingPeriod: "voteForThisEpoch" | "voteForNextEpoch"

VrfOutput

VrfOutput: string

VrfProof

VrfProof: string