Class BlockfrostUtxoProvider

Hierarchy

BlockfrostProvider
- BlockfrostUtxoProvider

Implements

UtxoProvider

Constructors

constructor

new BlockfrostUtxoProvider(dependencies: BlockfrostUtxoProviderDependencies): BlockfrostUtxoProvider
Parameters
- dependencies: BlockfrostUtxoProviderDependencies
Returns BlockfrostUtxoProvider
Overrides BlockfrostProvider.constructor
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:25
new BlockfrostUtxoProvider(options: BlockfrostUtxoProviderOptions, dependencies: BlockfrostUtxoProviderDependencies): BlockfrostUtxoProvider
Parameters
- options: BlockfrostUtxoProviderOptions
- dependencies: BlockfrostUtxoProviderDependencies
Returns BlockfrostUtxoProvider
Overrides BlockfrostProvider.constructor
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:28

Properties

`Private` #client

#client: BlockfrostClient

`Private` `Readonly` cache

cache: Cache<Tx<TxBody>>

`Protected` logger

logger: Logger

`Protected` `Readonly` queryUtxosByCredentials

queryUtxosByCredentials: boolean

Methods

`Private` fetchAllByPaymentCredentials

fetchAllByPaymentCredentials(credentials: Map<PaymentCredential, PaymentAddress[]>): Promise<Utxo[]>
Parameters
- credentials: Map<PaymentCredential, PaymentAddress[]>
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:159

`Private` fetchAllByRewardAccounts

fetchAllByRewardAccounts(rewardAccounts: Map<RewardAccount, PaymentAddress[]>, paymentCredentialFilter: ((address: PaymentAddress) => boolean)): Promise<Utxo[]>
Parameters
- rewardAccounts: Map<RewardAccount, PaymentAddress[]>
- paymentCredentialFilter: ((address: PaymentAddress) => boolean)
  - - (address: PaymentAddress): boolean
    - Parameters
      
      address: PaymentAddress
      
      Returns boolean
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:168

fetchCBOR

fetchCBOR(hash: string): Promise<string>
Parameters
- hash: string
Returns Promise<string>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:230

`Protected` fetchDetailsFromCBOR

fetchDetailsFromCBOR(hash: string): Promise<null | Tx<TxBody>>
Parameters
- hash: string
Returns Promise<null | Tx<TxBody>>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:240

`Private` fetchSkippedAddresses

fetchSkippedAddresses(skippedAddresses: {
byron: PaymentAddress[];
pointer: PaymentAddress[];
}): Promise<Utxo[]>
Parameters
- skippedAddresses: {
  byron: PaymentAddress[];
  pointer: PaymentAddress[];
  }
  - byron: PaymentAddress[]
  - pointer: PaymentAddress[]
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:191

`Protected` fetchUtxos

fetchUtxos(addr: PaymentAddress, paginationQueryString: string): Promise<Utxo[]>
Parameters
- addr: PaymentAddress
- paginationQueryString: string
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:47

`Private` fetchUtxosByCredentials

fetchUtxosByCredentials(addresses: PaymentAddress[]): Promise<Utxo[]>
Parameters
- addresses: PaymentAddress[]
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:199

`Protected` fetchUtxosByPaymentCredential

fetchUtxosByPaymentCredential(credential: PaymentCredential): Promise<Utxo[]>
Parameters
- credential: PaymentCredential
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:70

`Protected` fetchUtxosByRewardAccount

fetchUtxosByRewardAccount(rewardAccount: RewardAccount, paymentCredentialFilter: ((address: PaymentAddress) => boolean)): Promise<Utxo[]>
Parameters
- rewardAccount: RewardAccount
- paymentCredentialFilter: ((address: PaymentAddress) => boolean)
  - - (address: PaymentAddress): boolean
    - Parameters
      
      address: PaymentAddress
      
      Returns boolean
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:84

`Private` fetchUtxosForAddresses

fetchUtxosForAddresses(addresses: PaymentAddress[]): Promise<Utxo[]>
Parameters
- addresses: PaymentAddress[]
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:180

healthCheck

healthCheck(): Promise<HealthCheckResponse>
Returns Promise<HealthCheckResponse>
Implementation of UtxoProvider.healthCheck

Inherited from BlockfrostProvider.healthCheck
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:55

`Private` logMinimizationStats

logMinimizationStats(totalAddresses: number, minimized: {
    paymentCredentials: Map<unknown, unknown>;
    rewardAccounts: Map<unknown, unknown>;
}, skippedAddresses: {
    byron: PaymentAddress[];
    pointer: PaymentAddress[];
}): void
Parameters
- totalAddresses: number
- minimized: {
  paymentCredentials: Map<unknown, unknown>;
  rewardAccounts: Map<unknown, unknown>;
  }
  - paymentCredentials: Map<unknown, unknown>
  - rewardAccounts: Map<unknown, unknown>
- skippedAddresses: {
  byron: PaymentAddress[];
  pointer: PaymentAddress[];
  }
  - byron: PaymentAddress[]
  - pointer: PaymentAddress[]
Returns void
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:143

`Private` logSkippedAddresses

logSkippedAddresses(skippedAddresses: {
byron: PaymentAddress[];
pointer: PaymentAddress[];
}): void
Parameters
- skippedAddresses: {
  byron: PaymentAddress[];
  pointer: PaymentAddress[];
  }
  - byron: PaymentAddress[]
  - pointer: PaymentAddress[]
Returns void
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:127

`Protected` mergeAndDeduplicateUtxos

mergeAndDeduplicateUtxos(paymentUtxos: Utxo[], rewardAccountUtxos: Utxo[], skippedAddressUtxos: Utxo[]): Utxo[]
Parameters
- paymentUtxos: Utxo[]
- rewardAccountUtxos: Utxo[]
- skippedAddressUtxos: Utxo[]
Returns Utxo[]
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:113

`Private` processUtxoContents

processUtxoContents(utxoContents: {}[]): Promise<Utxo[]>
Parameters
- utxoContents: {}[]
Returns Promise<Utxo[]>
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:60

`Protected` request

request<T>(endpoint: string, requestInit?: RequestInit): Promise<T>
Throws
Type Parameters
- T
Parameters
- endpoint: string
  
  e.g. 'blocks/latest'
- Optional requestInit: RequestInit
  
  request options
Returns Promise<T>
Inherited from BlockfrostProvider.request
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:43

`Protected` toProviderError

toProviderError(error: unknown): ProviderError<unknown>
Parameters
- error: unknown
Returns ProviderError<unknown>
Inherited from BlockfrostProvider.toProviderError
- Defined in packages/cardano-services-client/src/blockfrost/BlockfrostProvider.ts:64

utxoByAddresses

utxoByAddresses(__namedParameters: UtxoByAddressesArgs): Promise<Utxo[]>
Retrieves UTXOs for the given addresses.

Important assumption: All addresses provided must be addresses where the caller controls the payment credential. When queryUtxosByCredentials is enabled, this provider queries by reward accounts (stake addresses) and filters results to only include UTXOs with payment credentials extracted from the input addresses. UTXOs with payment credentials not present in the input will be excluded.
Parameters
- __namedParameters: UtxoByAddressesArgs
Returns Promise<Utxo[]>
Implementation of UtxoProvider.utxoByAddresses
- Defined in packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts:272

Class BlockfrostUtxoProvider

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dependencies: BlockfrostUtxoProviderDependencies

Returns BlockfrostUtxoProvider

Parameters

options: BlockfrostUtxoProviderOptions

dependencies: BlockfrostUtxoProviderDependencies

Returns BlockfrostUtxoProvider

Properties

Private #client

Private Readonly cache

Protected logger

Protected Readonly queryUtxosByCredentials

Methods

Private fetchAllByPaymentCredentials

Parameters

credentials: Map<PaymentCredential, PaymentAddress[]>

Returns Promise<Utxo[]>

Private fetchAllByRewardAccounts

Parameters

rewardAccounts: Map<RewardAccount, PaymentAddress[]>

paymentCredentialFilter: ((address: PaymentAddress) => boolean)

Parameters

address: PaymentAddress

Returns boolean

Returns Promise<Utxo[]>

fetchCBOR

Parameters

hash: string

Returns Promise<string>

Protected fetchDetailsFromCBOR

Parameters

hash: string

Returns Promise<null | Tx<TxBody>>

Private fetchSkippedAddresses

Parameters

skippedAddresses: { byron: PaymentAddress[]; pointer: PaymentAddress[]; }

byron: PaymentAddress[]

pointer: PaymentAddress[]

Returns Promise<Utxo[]>

Protected fetchUtxos

Parameters

addr: PaymentAddress

paginationQueryString: string

Returns Promise<Utxo[]>

Private fetchUtxosByCredentials

Parameters

addresses: PaymentAddress[]

Returns Promise<Utxo[]>

Protected fetchUtxosByPaymentCredential

Parameters

credential: PaymentCredential

Returns Promise<Utxo[]>

Protected fetchUtxosByRewardAccount

Parameters

rewardAccount: RewardAccount

paymentCredentialFilter: ((address: PaymentAddress) => boolean)

Parameters

address: PaymentAddress

Returns boolean

Returns Promise<Utxo[]>

Private fetchUtxosForAddresses

Parameters

addresses: PaymentAddress[]

Returns Promise<Utxo[]>

healthCheck

Returns Promise<HealthCheckResponse>

Private logMinimizationStats

Parameters

totalAddresses: number

minimized: { paymentCredentials: Map<unknown, unknown>; rewardAccounts: Map<unknown, unknown>; }

paymentCredentials: Map<unknown, unknown>

`Private` #client

`Private` `Readonly` cache

`Protected` logger

`Protected` `Readonly` queryUtxosByCredentials

`Private` fetchAllByPaymentCredentials

`Private` fetchAllByRewardAccounts

`Protected` fetchDetailsFromCBOR

`Private` fetchSkippedAddresses

skippedAddresses: {
byron: PaymentAddress[];
pointer: PaymentAddress[];
}

`Protected` fetchUtxos

`Private` fetchUtxosByCredentials

`Protected` fetchUtxosByPaymentCredential

`Protected` fetchUtxosByRewardAccount

`Private` fetchUtxosForAddresses

`Private` logMinimizationStats

minimized: {
paymentCredentials: Map<unknown, unknown>;
rewardAccounts: Map<unknown, unknown>;
}

skippedAddresses: {
byron: PaymentAddress[];
pointer: PaymentAddress[];
}

`Private` logSkippedAddresses

skippedAddresses: {
byron: PaymentAddress[];
pointer: PaymentAddress[];
}

`Protected` mergeAndDeduplicateUtxos

`Private` processUtxoContents

`Protected` request

`Optional` requestInit: RequestInit

`Protected` toProviderError