Class BlockfrostProvider

constructor

• new BlockfrostProvider(config: BlockfrostProviderConfig): BlockfrostProvider

• Creates an instance of BlockfrostProvider.

  Parameters

  • config: BlockfrostProviderConfig

    The configuration object for the provider.

    • OptionalbaseUrl?: string

      An optional, custom base URL for the Blockfrost API. Overrides the network setting for URL construction.

    • network: NetworkMagic

      The network identifier (e.g., Mainnet, Preprod). This is ignored if a custom url is provided.

    • projectId: string

      The Blockfrost project ID for authentication.

  Returns BlockfrostProvider

url

confirmTransaction

• confirmTransaction(txId: string, timeout?: number): Promise<boolean>

• Confirms a transaction by its ID.

  Parameters

  • txId: string

    The transaction ID to confirm.
  • Optionaltimeout: number

    Optional timeout in milliseconds. If omitted, uses a default.

  Returns Promise<boolean>

  A promise that resolves to true if the transaction is confirmed, otherwise false.

evaluateTransaction

• evaluateTransaction(tx: string, additionalUtxos?: UTxO[]): Promise<Redeemer[]>

• Evaluates a transaction by its CBOR representation.

  Parameters

  • tx: string

    The hex-encoded CBOR of the transaction to evaluate.
  • OptionaladditionalUtxos: UTxO[] = []

    Optional additional UTxOs to include in the evaluation.

  Returns Promise<Redeemer[]>

  A promise that resolves to an array of Redeemer objects with execution units.

getName

• getName(): string

• Gets the human-readable name of the provider.

  Returns string

  The name of the provider.

getNetworkMagic

• getNetworkMagic(): NetworkMagic

• Gets the network magic/ID for the provider.

  Returns NetworkMagic

  The network identifier.

getParameters

• getParameters(): Promise<ProtocolParameters>

• Retrieves the protocol parameters from the Blockfrost API.

  Returns Promise<ProtocolParameters>

  A promise that resolves to the protocol parameters.

getRewardsBalance

• getRewardsBalance(address: string | RewardAddress): Promise<bigint>

• Get the current staking rewards balance for a reward account.

  Parameters

  • address: string | RewardAddress

    Reward account address or bech32 string.

  Returns Promise<bigint>

  A promise that resolves to the balance in lovelace.

getUnspentOutputByNft

• getUnspentOutputByNft(assetId: string): Promise<UTxO>

• Retrieves the unspent output (UTxO) that holds a specific NFT asset.

  Parameters

  • assetId: string

    The asset identifier of the NFT (policyId + asset name in hex).

  Returns Promise<UTxO>

  A promise that resolves to the UTxO containing the NFT.

getUnspentOutputs

• getUnspentOutputs(address: string | Address): Promise<UTxO[]>

• List all unspent transaction outputs (UTxOs) controlled by an address.

  Parameters

  • address: string | Address

    Payment address. Address object or bech32 string.

  Returns Promise<UTxO[]>

  A promise that resolves to an array of UTxOs.

getUnspentOutputsWithAsset

• getUnspentOutputsWithAsset(
      address: string | Address,
      assetId: string,
  ): Promise<UTxO[]>

• List all UTxOs for an address that contain a specific asset.

  Parameters

  • address: string | Address

    Payment address. Address object or bech32 string.
  • assetId: string

    Asset identifier (policyId + asset name hex).

  Returns Promise<UTxO[]>

  A promise that resolves to matching UTxOs.

headers

• headers(): { Origin: string; project_id: string }

• Returns the headers required for Blockfrost API requests.

  Returns { Origin: string; project_id: string }

  An object containing the project ID header.

resolveDatum

• resolveDatum(datumHash: string): Promise<string>

• Resolves a datum by its hash.

  Parameters

  • datumHash: string

    The hex-encoded hash of the datum.

  Returns Promise<string>

  A promise that resolves to the CBOR-encoded datum.

resolveUnspentOutputs

• resolveUnspentOutputs(txIns: TxIn[]): Promise<UTxO[]>

• Resolves unspent outputs (UTxOs) for a list of transaction inputs.

  Parameters

  • txIns: TxIn[]

    An array of transaction inputs to resolve.

  Returns Promise<UTxO[]>

  A promise that resolves to an array of UTxOs.

submitTransaction

• submitTransaction(tx: string): Promise<string>

• Submits a signed transaction to the Blockfrost API.

  Parameters

  • tx: string

    The hex-encoded transaction payload.

  Returns Promise<string>

  A promise that resolves to the submitted transaction ID (hash).