docs
API
Generated with
docs/scalus/scalus.cardano/scalus.cardano.node/BlockchainProvider

BlockchainProvider

scalus.cardano.node.BlockchainProvider
trait BlockchainProvider extends BlockchainProviderTF[Future], BlockchainReader

Provider for Cardano blockchain operations.

Provider is the cross-platform interface for interacting with Cardano nodes. All methods return Future values and work on both JVM and JavaScript platforms.

Extends BlockchainReader with transaction submission capability.

Implementations capture their ExecutionContext at construction time, so callers don't need to provide it for each method call.

Use scalus.utils.await extension for blocking operations on JVM when needed.

Attributes

Graph
Supertypes
trait BlockchainProviderTF[Future]
trait BlockchainReaderTF[Future]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait EmulatorBase
class Emulator

Members list

Value members

Abstract methods

def submit(transaction: Transaction): Future[Either[SubmitError, TransactionHash]]

Submits a transaction to the network.

Submits a transaction to the network.

Attributes

Deprecated methods

def findUtxo(address: Address, transactionId: Option[TransactionHash] = ..., datum: Option[DatumOption] = ..., minAmount: Option[Coin] = ...): Future[Either[UtxoQueryError, Utxo]]

Find a single UTxO by address and optional filters.

Find a single UTxO by address and optional filters.

Attributes

Deprecated
[Since version 0.14.2] Use findUtxos(UtxoQuery) instead

Use findUtxos(UtxoQuery) instead

def findUtxos(address: Address, transactionId: Option[TransactionHash] = ..., datum: Option[DatumOption] = ..., minAmount: Option[Coin] = ..., minRequiredTotalAmount: Option[Coin] = ...): Future[Either[UtxoQueryError, Utxos]]

Find UTxOs by address and optional filters.

Find UTxOs by address and optional filters.

Attributes

Deprecated
[Since version 0.14.2] Use findUtxos(UtxoQuery) instead

Use findUtxos(UtxoQuery) instead

Inherited methods

def findUtxo(input: TransactionInput): Future[Either[UtxoQueryError, Utxo]]

Find a single UTxO by its transaction input.

Find a single UTxO by its transaction input.

Value parameters

input

the transaction input to look up

Attributes

Returns

Either a UtxoQueryError or the found Utxo

Inherited from:
BlockchainReader
def findUtxos(address: Address): Future[Either[UtxoQueryError, Utxos]]

Find all UTxOs at the given address.

Find all UTxOs at the given address.

Value parameters

address

the address to query

Attributes

Returns

Either a UtxoQueryError or the found UTxOs

Inherited from:
BlockchainReader
def findUtxos(inputs: Set[TransactionInput]): Future[Either[UtxoQueryError, Utxos]]

Find UTxOs by a set of transaction inputs.

Find UTxOs by a set of transaction inputs.

Value parameters

inputs

the transaction inputs to look up

Attributes

Returns

Either a UtxoQueryError or the found UTxOs (fails if not all inputs are found)

Inherited from:
BlockchainReader
inline def queryUtxos(inline f: Utxo => Boolean): UtxoQueryWithReader

Query UTxOs using lambda DSL.

Query UTxOs using lambda DSL.

This method translates a lambda expression to a UtxoQuery at compile time and returns a builder that can be further configured before execution.

Example:

// Simple query - execute immediately
reader.queryUtxos { u =>
 u.output.address == myAddress
}.execute()

// With pagination and minimum total
reader.queryUtxos { u =>
 u.output.address == myAddress && u.output.value.hasAsset(policyId, assetName)
}.minTotal(Coin.ada(100)).limit(10).execute()

Supported expressions:

  • u.output.address == addr - query by address
  • u.input.transactionId == txId - query by transaction
  • u.output.value.hasAsset(policyId, assetName) - query/filter by asset
  • u.output.value.coin >= amount - filter by minimum lovelace
  • u.output.hasDatumHash(hash) - filter by datum hash
  • && - AND combination
  • || - OR combination

Value parameters

f

Lambda expression from Utxo to Boolean

Attributes

Returns

A UtxoQueryWithReader builder that can be configured and executed

Inherited from:
BlockchainReader

Inherited and Abstract methods

def cardanoInfo: CardanoInfo

Returns CardanoInfo for this reader.

Returns CardanoInfo for this reader.

This is always available synchronously after the reader is constructed. For emulators, this returns the current context. For remote providers like BlockfrostProvider, the CardanoInfo is fetched during async construction.

Attributes

Inherited from:
BlockchainReader
def currentSlot: Future[SlotNo]

Returns the current slot number.

Returns the current slot number.

Attributes

Inherited from:
BlockchainReader
def executionContext: ExecutionContext

Returns the ExecutionContext captured by this reader.

Returns the ExecutionContext captured by this reader.

This is used internally by default method implementations. External code can use this when working with Futures returned by reader methods, or provide their own.

Attributes

Inherited from:
BlockchainReader
def fetchLatestParams: Future[ProtocolParams]

Fetches the latest protocol parameters from the network.

Fetches the latest protocol parameters from the network.

Attributes

Inherited from:
BlockchainReader
def findUtxos(query: UtxoQuery): Future[Either[UtxoQueryError, Utxos]]

Find UTxOs using a type-safe query.

Find UTxOs using a type-safe query.

Value parameters

query

The query specifying source, filters, and pagination

Attributes

Returns

Either a UtxoQueryError or the matching UTxOs

Inherited from:
BlockchainReader
Generated with