Index

Interfaces

Type aliases

Type aliases

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

AnyStakeCredential

AnyStakeCredential: Base16 | Bech32 | StakeAddress

ArrayNoSchema

ArrayNoSchema: MetadatumNoSchema[]

AssetQuantity

AssetQuantity: bigint

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

Base16

Base16: string

A stake key or script hash in base16.

Bech32

Bech32: string

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

Block

BlockHeight

BlockHeight: number

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

BootstrapProtocolId

BootstrapProtocolId: number

Certificate

ChainCode

ChainCode: string

An Ed25519-BIP32 chain-code for key deriviation.

CostModel

CostModel: Int64[]

Datum

Datum: string

DelegateRepresentative

DigestAny

DigestAny: string

A hash digest from an unspecified algorithm and length.

DigestBlake2B224

DigestBlake2B224: string

A Blake2b 28-byte hash digest, encoded in base16.

DigestBlake2B256

DigestBlake2B256: string

A Blake2b 32-byte hash digest, encoded in base16.

Epoch

Epoch: number

An epoch number or length.

Era

Era: "byron" | "shelley" | "allegra" | "mary" | "alonzo" | "babbage" | "conway"

EraWithGenesis

EraWithGenesis: "byron" | "shelley" | "alonzo" | "conway"

EvaluateTransactionFailure

ExtendedVerificationKey

ExtendedVerificationKey: string

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

GenesisHash

GenesisHash: "genesis"

InitialDelegates

InitialDelegates: object[]

Int64

Int64: number

IntegerNoSchema

IntegerNoSchema: bigint

KesVerificationKey

KesVerificationKey: string

Language

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

Metadatum

MetadatumDetailedSchema

MetadatumNoSchema

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

None

None: 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

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.

PolicyId

PolicyId: string

A Blake2b 28-byte hash digest, encoded in base16.

Ratio

Ratio: string

A ratio of two integers, to express exact fractions.

RedeemerData

RedeemerData: string

Plutus data, CBOR-serialised.

Relay

RewardAccount

RewardAccount: string

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

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

Script: Native | Plutus

ScriptExecutionFailure

ScriptNative

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

ScriptPurpose

Signature

Signature: string

An EdDSA signature.

Slot

Slot: number

An absolute slot number.

StakeAddress

StakeAddress: string

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

StakePoolId

StakePoolId: string

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

StringNoSchema

StringNoSchema: string

SubmitTransactionFailure

SubmitTransactionFailure: SubmitTransactionFailureEraMismatch | SubmitTransactionFailureInvalidSignatories | SubmitTransactionFailureMissingSignatories | SubmitTransactionFailureMissingScripts | SubmitTransactionFailureFailingNativeScript | SubmitTransactionFailureExtraneousScripts | SubmitTransactionFailureMissingMetadataHash | SubmitTransactionFailureMissingMetadata | SubmitTransactionFailureMetadataHashMismatch | SubmitTransactionFailureInvalidMetadata | SubmitTransactionFailureMissingRedeemers | SubmitTransactionFailureExtraneousRedeemers | SubmitTransactionFailureMissingDatums | SubmitTransactionFailureExtraneousDatums | SubmitTransactionFailureScriptIntegrityHashMismatch | SubmitTransactionFailureOrphanScriptInputs | SubmitTransactionFailureMissingCostModels | SubmitTransactionFailureMalformedScripts | SubmitTransactionFailureUnknownOutputReferences | SubmitTransactionFailureOutsideOfValidityInterval | SubmitTransactionFailureTransactionTooLarge | SubmitTransactionFailureValueTooLarge | SubmitTransactionFailureEmptyInputSet | SubmitTransactionFailureTransactionFeeTooSmall | SubmitTransactionFailureValueNotConserved | SubmitTransactionFailureNetworkMismatch | SubmitTransactionFailureInsufficientlyFundedOutputs | SubmitTransactionFailureBootstrapAttributesTooLarge | SubmitTransactionFailureMintingOrBurningAda | SubmitTransactionFailureInsufficientCollateral | SubmitTransactionFailureCollateralLockedByScript | SubmitTransactionFailureUnforeseeableSlot | SubmitTransactionFailureTooManyCollateralInputs | SubmitTransactionFailureMissingCollateralInputs | SubmitTransactionFailureNonAdaCollateral | SubmitTransactionFailureExecutionUnitsTooLarge | SubmitTransactionFailureTotalCollateralMismatch | SubmitTransactionFailureSpendsMismatch | SubmitTransactionFailureUnauthorizedVotes | SubmitTransactionFailureUnknownGovernanceProposals | SubmitTransactionFailureInvalidProtocolParametersUpdate | SubmitTransactionFailureUnknownStakePool | SubmitTransactionFailureIncompleteWithdrawals | SubmitTransactionFailureRetirementTooLate | SubmitTransactionFailureStakePoolCostTooLow | SubmitTransactionFailureMetadataHashTooLarge | SubmitTransactionFailureCredentialAlreadyRegistered | SubmitTransactionFailureUnknownCredential | SubmitTransactionFailureNonEmptyRewardAccount | SubmitTransactionFailureInvalidGenesisDelegation | SubmitTransactionFailureInvalidMIRTransfer | SubmitTransactionFailureForbiddenWithdrawal | SubmitTransactionFailureCredentialDepositMismatch | SubmitTransactionFailureDRepAlreadyRegistered | SubmitTransactionFailureDRepNotRegistered | SubmitTransactionFailureUnknownConstitutionalCommitteeMember | SubmitTransactionFailureGovernanceProposalDepositMismatch | SubmitTransactionFailureConflictingCommitteeUpdate | SubmitTransactionFailureInvalidCommitteeUpdate | SubmitTransactionFailureTreasuryWithdrawalMismatch | SubmitTransactionFailureInvalidOrMissingPreviousProposals | SubmitTransactionFailureVotingOnExpiredActions | SubmitTransactionFailureExecutionBudgetOutOfBounds | SubmitTransactionFailureInvalidHardForkVersionBump | SubmitTransactionFailureConstitutionGuardrailsHashMismatch | SubmitTransactionFailureUnrecognizedCertificateType

TipOrOrigin

TipOrOrigin: Tip | Origin

TransactionId

TransactionId: string

A Blake2b 32-byte hash digest of a transaction body

UInt32

UInt32: number

UInt64

UInt64: number

UtcTime

UtcTime: string

Utxo

Utxo: object[]

VerificationKey

VerificationKey: string

An Ed25519 verification key.

VrfOutput

VrfOutput: string

VrfProof

VrfProof: string