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

BlockfrostProvider

scalus.cardano.node.BlockfrostProvider
See theBlockfrostProvider companion class
object BlockfrostProvider

Companion object for BlockfrostProvider with factory methods and utilities.

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def create(apiKey: String, baseUrl: String, network: Network, slotConfig: SlotConfig, maxConcurrentRequests: Int = ...)(using ec: ExecutionContext): Future[BlockfrostProvider]

Create a BlockfrostProvider with custom configuration.

Create a BlockfrostProvider with custom configuration.

Fetches protocol parameters during construction.

Value parameters

apiKey

Blockfrost API key

baseUrl

Blockfrost-compatible API base URL

maxConcurrentRequests

Maximum concurrent HTTP requests (default 5)

network

Cardano network (Mainnet or Testnet)

slotConfig

Slot configuration for the network

Attributes

Returns

Future containing the configured BlockfrostProvider

def fetchYaciSlotConfig(adminUrl: String)(using backend: Backend[Future], ec: ExecutionContext): Future[SlotConfig]

Fetch slot configuration from a Yaci DevKit admin API.

Fetch slot configuration from a Yaci DevKit admin API.

Calls GET {adminUrl}/admin/devnet and extracts startTime (epoch seconds) and slotLength (seconds as double) from the response JSON.

Value parameters

adminUrl

Yaci admin API base URL (e.g. http://localhost:10000/local-cluster/api)

Attributes

Returns

Future containing the SlotConfig

def localYaci(baseUrl: String = ..., adminUrl: String = ..., maxConcurrentRequests: Int = ...)(using ec: ExecutionContext): Future[BlockfrostProvider]

Create a BlockfrostProvider for local Yaci DevKit.

Create a BlockfrostProvider for local Yaci DevKit.

Fetches protocol parameters and slot configuration during construction. The slot config is fetched from the Yaci admin API (/admin/devnet) to get the correct startTime.

Value parameters

adminUrl

Yaci admin API URL (default: http://localhost:10000/local-cluster/api)

baseUrl

API base URL (default: http://localhost:8080/api/v1)

maxConcurrentRequests

Maximum concurrent HTTP requests (default 5)

Attributes

Returns

Future containing the configured BlockfrostProvider

def mainnet(apiKey: String, maxConcurrentRequests: Int = ...)(using ec: ExecutionContext): Future[BlockfrostProvider]

Create a BlockfrostProvider for Cardano mainnet.

Create a BlockfrostProvider for Cardano mainnet.

Fetches protocol parameters during construction.

Value parameters

apiKey

Blockfrost API key

maxConcurrentRequests

Maximum concurrent HTTP requests (default 5)

Attributes

Returns

Future containing the configured BlockfrostProvider

def parseUtxos(json: String): Utxos
def preprod(apiKey: String, maxConcurrentRequests: Int = ...)(using ec: ExecutionContext): Future[BlockfrostProvider]

Create a BlockfrostProvider for Cardano preprod testnet.

Create a BlockfrostProvider for Cardano preprod testnet.

Fetches protocol parameters during construction.

Value parameters

apiKey

Blockfrost API key

maxConcurrentRequests

Maximum concurrent HTTP requests (default 5)

Attributes

Returns

Future containing the configured BlockfrostProvider

def preview(apiKey: String, maxConcurrentRequests: Int = ...)(using ec: ExecutionContext): Future[BlockfrostProvider]

Create a BlockfrostProvider for Cardano preview testnet.

Create a BlockfrostProvider for Cardano preview testnet.

Fetches protocol parameters during construction.

Value parameters

apiKey

Blockfrost API key

maxConcurrentRequests

Maximum concurrent HTTP requests (default 5)

Attributes

Returns

Future containing the configured BlockfrostProvider

Concrete fields

val localAdminUrl: String

Local Yaci DevKit admin API URL

Local Yaci DevKit admin API URL

Attributes

val localUrl: String

Local Yaci DevKit API URL

Local Yaci DevKit API URL

Attributes

val mainnetUrl: String

Blockfrost API URL for Cardano mainnet

Blockfrost API URL for Cardano mainnet

Attributes

val preprodUrl: String

Blockfrost API URL for Cardano preprod testnet

Blockfrost API URL for Cardano preprod testnet

Attributes

val previewUrl: String

Blockfrost API URL for Cardano preview testnet

Blockfrost API URL for Cardano preview testnet

Attributes

Deprecated fields

val LocalUrl: String

Attributes

Deprecated
[Since version 0.14.1] Use localUrl instead
val MainnetUrl: String

Attributes

Deprecated
[Since version 0.14.1] Use mainnetUrl instead
val PreprodUrl: String

Attributes

Deprecated
[Since version 0.14.1] Use preprodUrl instead
val PreviewUrl: String

Attributes

Deprecated
[Since version 0.14.1] Use previewUrl instead
Generated with