Evolution SDK
ModulesSdkProvider

sdk/provider/Koios.ts

Koios overview


Table of contents


constructors

Koios (class)

Koios provider for Cardano blockchain data access. Provides support for interacting with the Koios API across multiple environments. Supports optional bearer token authentication.

Signature

export declare class Koios {
  constructor(baseUrl: string, token?: string)
}

Added in v2.0.0

Effect (property)

Signature

readonly Effect: ProviderEffect

getProtocolParameters (property)

Signature

getProtocolParameters: () => Promise<ProtocolParameters>

getUtxos (property)

Signature

getUtxos: (addressOrCredential: Parameters<Provider["getUtxos"]>[0]) => Promise<UTxO[]>

getUtxosWithUnit (property)

Signature

getUtxosWithUnit: (
  addressOrCredential: Parameters<Provider["getUtxosWithUnit"]>[0],
  unit: Parameters<Provider["getUtxosWithUnit"]>[1]
) => Promise<UTxO[]>

getUtxoByUnit (property)

Signature

getUtxoByUnit: (unit: Parameters<Provider["getUtxoByUnit"]>[0]) => Promise<UTxO>

getUtxosByOutRef (property)

Signature

getUtxosByOutRef: (outRefs: Parameters<Provider["getUtxosByOutRef"]>[0]) => Promise<UTxO[]>

getDelegation (property)

Signature

getDelegation: (rewardAddress: Parameters<Provider["getDelegation"]>[0]) => Promise<Delegation>

getDatum (property)

Signature

getDatum: (datumHash: Parameters<Provider["getDatum"]>[0]) => Promise<Data>

awaitTx (property)

Signature

awaitTx: (
  txHash: Parameters<Provider["awaitTx"]>[0],
  checkInterval?: Parameters<Provider["awaitTx"]>[1],
  timeout?: Parameters<Provider["awaitTx"]>[2]
) => Promise<boolean>

submitTx (property)

Signature

submitTx: (tx: Parameters<Provider["submitTx"]>[0]) => Promise<TransactionHash>

evaluateTx (property)

Signature

evaluateTx: (tx: Parameters<Provider["evaluateTx"]>[0], additionalUTxOs?: Parameters<Provider["evaluateTx"]>[1]) =>
  Promise<EvalRedeemer[]>