Main Navigation Home Docs Typedoc API Playground

Appearance

Sidebar Navigation

Getting Started

Quickstart

Initialization

Accounts & Keys

Glossary

Transactions

Basic Transactions

Rewards & Stake Registration

Mint & Burn Tokens

Smart Contracts TXs

Governance Actions

Advanced Usage

Providers

Utilities & Libraries

Native Scripts

Plutus Data

Sign & Verify Message

Addresses

Accessing Types

Explorers

Koios

Ogmios

Kupo

XRAY/Graph NFTCDN

Typedoc API

API Reference

Declarations

Namespaces

CML

Enumerations

AddressHeaderKind

AddressKind

AuxiliaryDataKind

ByronAddrType

CardanoNodePlutusDatumSchema

CertificateKind

ChangeSelectionAlgo

ChunkableStringKind

CIP25Version

CoinSelectionStrategyCIP2

CredentialKind

DatumOptionKind

DelegationDistributionKind

DRepKind

GovActionKind

Language

MetadataJsonSchema

NativeScriptKind

NonceKind

PlutusDataKind

RedeemersKind

RedeemerTag

RelayKind

ScriptKind

SpendingDataKind

StakeDistributionKind

TransactionMetadatumKind

TransactionOutputKind

Vote

VoterKind

Classes

AddrAttributes

Address

AddressContent

AddressId

AlonzoFormatTxOut

Anchor

AnchorDocHash

AssetName

AssetNameList

AuthCommitteeHotCert

AuxiliaryData

AuxiliaryDataHash

BaseAddress

BigInteger

Bip32PrivateKey

Bip32PublicKey

Block

BlockBodyHash

BlockHeaderHash

BootstrapWitness

BootstrapWitnessList

ByronAddress

ByronGenesisRedeem

ByronScript

ByronTxOut

Certificate

CertificateBuilderResult

CertificateList

CIP25ChunkableString

CIP25FilesDetails

CIP25LabelMetadata

CIP25Metadata

CIP25MetadataDetails

CIP25MiniMetadataDetails

CIP25String64

CIP25String64List

CIP36Delegation

CIP36DelegationDistribution

CIP36DelegationList

CIP36DeregistrationCbor

CIP36DeregistrationWitness

CIP36KeyDeregistration

CIP36KeyRegistration

CIP36RegistrationCbor

CIP36RegistrationWitness

CommitteeColdCredentialList

Constitution

ConstrPlutusData

ConwayFormatAuxData

ConwayFormatTxOut

CostModels

Crc32

Credential

DatumHash

DatumOption

DNSName

DRep

DRepVotingThresholds

Ed25519KeyHash

Ed25519KeyHashList

Ed25519Signature

EnterpriseAddress

ExUnitPrices

ExUnits

FilesDetailsList

GenesisDelegateHash

GenesisHash

GovAction

GovActionId

GovActionIdList

HardForkInitiationAction

HDAddressPayload

Header

HeaderBody

InputAggregateWitnessData

InputBuilderResult

Int

IntList

Ipv4

Ipv6

KESSignature

KESVkey

LanguageList

LegacyDaedalusPrivateKey

LegacyRedeemer

LegacyRedeemerList

LinearFee

MapAssetNameToCoin

MapAssetNameToNonZeroInt64

MapAssetNameToU64

MapCommitteeColdCredentialToEpoch

MapGovActionIdToVotingProcedure

MapPlutusDataToPlutusData

MapRedeemerKeyToRedeemerVal

MapRewardAccountToCoin

MapStakeCredentialToDeltaCoin

MapTransactionIndexToAuxiliaryData

MapTransactionMetadatumToTransactionMetadatum

MapU64ToArrI64

Metadata

MetadatumList

MetadatumMap

Mint

MintBuilderResult

MultiAsset

MultiHostName

NativeScript

NativeScriptList

NativeScriptWitnessInfo

NetworkId

NetworkInfo

NewConstitution

NoConfidence

Nonce

NonceHash

OperationalCert

ParameterChangeAction

PartialPlutusWitness

PlutusData

PlutusDataList

PlutusMap

PlutusScript

PlutusScriptWitness

PlutusV1Script

PlutusV1ScriptList

PlutusV2Script

PlutusV2ScriptList

PlutusV3Script

PlutusV3ScriptList

Pointer

PointerAddress

PolicyIdList

PoolMetadata

PoolMetadataHash

PoolParams

PoolRegistration

PoolRetirement

PoolVotingThresholds

PrivateKey

ProposalBuilder

ProposalBuilderResult

ProposalProcedure

ProposalProcedureList

ProtocolMagic

ProtocolParamUpdate

ProtocolVersion

PublicKey

Rational

RedeemerKey

RedeemerKeyList

Redeemers

RedeemerSetBuilder

RedeemerVal

RedeemerWitnessKey

RegCert

RegDrepCert

Relay

RelayList

RequiredWitnessSet

ResignCommitteeColdCert

RewardAccountList

RewardAddress

Script

ScriptAll

ScriptAny

ScriptDataHash

ScriptHash

ScriptInvalidBefore

ScriptInvalidHereafter

ScriptNOfK

ScriptPubkey

ShelleyMAFormatAuxData

SignedTxBuilder

SingleCertificateBuilder

SingleHostAddr

SingleHostName

SingleInputBuilder

SingleMintBuilder

SingleOutputBuilderResult

SingleWithdrawalBuilder

SpendingData

StakeCredentialList

StakeDelegation

StakeDeregistration

StakeDistribution

StakeholderId

StakeRegDelegCert

StakeRegistration

StakeVoteDelegCert

StakeVoteRegDelegCert

Transaction

TransactionBody

TransactionBodyList

TransactionBuilder

TransactionBuilderConfig

TransactionBuilderConfigBuilder

TransactionHash

TransactionInput

TransactionInputList

TransactionMetadatum

TransactionMetadatumLabels

TransactionMetadatumList

TransactionOutput

TransactionOutputAmountBuilder

TransactionOutputBuilder

TransactionOutputList

TransactionUnspentOutput

TransactionWitnessSet

TransactionWitnessSetBuilder

TransactionWitnessSetList

TreasuryWithdrawalsAction

TxRedeemerBuilder

UnitInterval

UnregCert

UnregDrepCert

UntaggedRedeemer

UpdateCommittee

UpdateDrepCert

Url

Value

Vkeywitness

VkeywitnessList

VoteBuilder

VoteBuilderResult

VoteDelegCert

Voter

VoteRegDelegCert

VoterList

VotingProcedure

VotingProcedures

VRFCert

VRFKeyHash

VRFVkey

WithdrawalBuilderResult

Functions

calc_script_data_hash

calc_script_data_hash_from_witness

compute_total_ex_units

decode_arbitrary_bytes_from_metadatum

decode_metadatum_to_json_str

decode_plutus_datum_to_json_str

emip3_decrypt_with_password

emip3_encrypt_with_password

encode_arbitrary_bytes_as_metadatum

encode_json_str_to_metadatum

encode_json_str_to_plutus_datum

genesis_txid_byron

genesis_txid_shelley

get_deposit

get_implicit_input

hash_auxiliary_data

hash_plutus_data

hash_script_data

hash_transaction

make_daedalus_bootstrap_witness

make_icarus_bootstrap_witness

make_vkey_witness

min_ada_required

min_fee

min_no_script_fee

min_script_fee

CW3Types

Classes

Account

Connector

TxBuilder

TxFinalizer

Type Aliases

AccountAddressDerivation

AccountConfig

AccountDelegation

AccountDerivationPath

AccountExportV1

AccountMultiAddressing

AccountState

AccountType

AddressCredentialType

AddressDerivationPath

AddressPublicCredentials

AddressType

Asset

Balance

CollateralConfig

ConnectorPaginate

CostModels

Credential

Datum

DatumOutput

DatumType

DerivationScheme

DRep

DrepAnchor

Exact

Explorers

Headers

InitConfig

Json

KoiosClient

KupoClient

NativeConfig

NativeScript

NativeScriptType

NetworkConfig

NetworkId

NetworkName

NetworkType

NftcdnClient

OgmiosClient

OmitFirstArg

Output

PlutusVersion

PoolConfig

ProtocolParameters

Provider

Redeemer

RedeemerCost

RelayConfig

Script

SignedMessage

SlotConfig

Tip

Utxo

Value

KoiosTypes

Type Aliases

$defs

components

operations

paths

webhooks

KupoTypes

Type Aliases

$defs

components

operations

paths

webhooks

MSL

Enumerations

AlgorithmId

CBORSpecialType

CBORValueKind

CurveType

ECKey

KeyOperation

KeyType

LabelKind

SigContext

SignedMessageKind

Classes

BigNum

CBORArray

CBORObject

CBORSpecial

CBORValue

COSEEncrypt

COSEEncrypt0

COSEKey

COSERecipient

COSERecipients

COSESign

COSESign1

COSESign1Builder

COSESignature

COSESignatures

COSESignBuilder

CounterSignature

EdDSA25519Key

HeaderMap

Headers

Int

Label

Labels

PasswordEncryption

ProtectedHeaderMap

PubKeyEncryption

SignedMessage

SigStructure

TaggedCBOR

NftcdnTypes

Type Aliases

$defs

components

operations

paths

webhooks

OgmiosTypes

Type Aliases

$defs

components

operations

paths

webhooks

PlutusData

Type Aliases

Static

UPLC

Functions

apply_params_to_script

eval_phase_two_raw

Classes

CardanoWeb3

KoiosProvider

KupmiosProvider

PlutusConstr

Type Aliases

PlutusData

Variables

Message

PlutusData

utils

Functions

KoiosClient

KupoClient

NftcdnClient

OgmiosClient

On this page

cardano-web3-js / OgmiosTypes

OgmiosTypes

Type Aliases

$defs
components
operations
paths
webhooks

Edit this page on GitHub

Pager

Previous pagewebhooks

Next page$defs

Released under the MIT License

CML

Enumerations

Classes

Functions

CW3Types

Classes

Type Aliases

KoiosTypes

Type Aliases

KupoTypes

Type Aliases

MSL

Enumerations

Classes

NftcdnTypes

Type Aliases

OgmiosTypes

Type Aliases

PlutusData

Type Aliases

UPLC

Functions

OgmiosTypes ​

Type Aliases ​

OgmiosTypes

Type Aliases