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

AssetQuantity

AssetQuantity: bigint

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

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

Credentials

Credentials: Hash16[]

Epoch

Epoch: number

An epoch number.

Era

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

GetBlockHeight

GetBlockHeight: "blockHeight"

GetChainTip

GetChainTip: "chainTip"

GetCurrentEpoch

GetCurrentEpoch: "currentEpoch"

GetCurrentProtocolParameters

GetCurrentProtocolParameters: "currentProtocolParameters"

GetEraStart

GetEraStart: "eraStart"

GetGenesisConfig

GetGenesisConfig: "genesisConfig"

GetLedgerTip

GetLedgerTip: "ledgerTip"

GetPoolIds

GetPoolIds: "poolIds"

GetPoolsRanking

GetPoolsRanking: "poolsRanking"

GetProposedProtocolParameters

GetProposedProtocolParameters: "proposedProtocolParameters"

GetRewardsProvenance

GetRewardsProvenance: "rewardsProvenance"

GetStakeDistribution

GetStakeDistribution: "stakeDistribution"

GetSystemStart

GetSystemStart: "systemStart"

GetUtxo

GetUtxo: "utxo"

Hash16

Hash16: string

A base16-encoded digest.

Hash64

Hash64: string

A base64-encoded digest.

Int64

Int64: number

InvalidEntity

InvalidEntity: object | object | object

InvalidMetadata

InvalidMetadata: "invalidMetadata"

Lovelace

Lovelace: number

LovelaceDelta

LovelaceDelta: number

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

Lovelaces

Lovelaces: Lovelace[]

Metadatum

Metadatum: Int | String | Bytes | List | Map

MirNegativeTransferNotCurrentlyAllowed

MirNegativeTransferNotCurrentlyAllowed: "mirNegativeTransferNotCurrentlyAllowed"

MirProducesNegativeUpdate

MirProducesNegativeUpdate: "mirProducesNegativeUpdate"

MirTransferNotCurrentlyAllowed

MirTransferNotCurrentlyAllowed: "mirTransferNotCurrentlyAllowed"

MissingAtLeastOneInputUtxo

MissingAtLeastOneInputUtxo: "missingAtLeastOneInputUtxo"

MissingCollateralInputs

MissingCollateralInputs: "missingCollateralInputs"

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

Nonce: Neutral | Hash16

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

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.

RelativeTime

RelativeTime: string

A time in seconds relative to the system start.

Relay

Relay: ByAddress | ByName

RewardAccount

RewardAccount: string

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

RewardAccountNotExisting

RewardAccountNotExisting: "rewardAccountNotExisting"

RewardPot

RewardPot: "reserves" | "treasury"

Source of rewards as defined by the protocol parameters.

Script

Script: Native | Plutus | Plutus1

ScriptNative

ScriptNative: Hash16 | Any | All | NOf | ExpiresAt | StartsAt

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

Slot

Slot: number

An absolute slot number.

SubmitSuccess

SubmitSuccess: "SubmitSuccess"

SubmitTxError

TipOrOrigin

TipOrOrigin: Tip | Origin

TriesToForgeAda

TriesToForgeAda: "triesToForgeAda"

Only since Mary.

TxWitness

UInt32

UInt32: number

UInt64

UInt64: number

UInt8

UInt8: number

UpdateAlonzo

UpdateAlonzo: Null | UpdateProposalAlonzo

UpdateShelley

UpdateShelley: Null | UpdateProposalShelley

UtcTime

UtcTime: string

Utxo

Utxo: [TxIn, TxOut][]

ValidationTagMismatch

ValidationTagMismatch: "validationTagMismatch"

VotingPeriod

VotingPeriod: "voteForThisEpoch" | "voteForNextEpoch"

WrongCertificateType

WrongCertificateType: "wrongCertificateType"