docs
API
Generated with
docs/scalus/scalus.cardano/scalus.cardano.blockfrost

scalus.cardano.blockfrost

package scalus.cardano.blockfrost

Members list

Type members

Classlikes

case class AccountAddress(address: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AccountDelegation(activeEpoch: Long, txHash: String, amount: Coin, poolId: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AccountInfo(stakeAddress: String, active: Boolean, activeEpoch: Option[Long], controlledAmount: Coin, rewardsSum: Coin, withdrawalsSum: Coin, reservesSum: Coin, treasurySum: Coin, withdrawableAmount: Coin, poolId: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AccountRegistration(txHash: String, action: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AccountReward(epoch: Long, amount: Coin, poolId: String, rewardType: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AddressInfo(address: String, amount: Seq[AssetAmount], stakeAddress: Option[String], addressType: String, script: Boolean)

Blockfrost/MiniBF API response models.

Blockfrost/MiniBF API response models.

All case classes derive upickle ReadWriter for JSON serialization. Field names use @key("snake_case") annotations where the Blockfrost JSON key differs from the Scala field name.

Coin is used for lovelace/ADA amounts. Quantity is used for other string-encoded numeric fields (asset quantities, execution unit budgets, voting power).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AddressTransaction(txHash: String, txIndex: Int, blockHeight: Long, blockTime: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ApiRootInfo(url: String, version: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AssetAddress(address: String, quantity: Quantity)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AssetAmount(unit: String, quantity: Quantity)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AssetInfo(asset: String, policyId: String, assetName: Option[String], fingerprint: String, quantity: Quantity, initialMintTxHash: String, mintOrBurnCount: Int, onchainMetadata: Option[Value], onchainMetadataStandard: Option[String], metadata: Option[AssetMetadata])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AssetMetadata(name: String, description: String, ticker: Option[String], url: Option[String], logo: Option[String], decimals: Option[Int])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AssetTransaction(txHash: String, txIndex: Int, blockHeight: Long, blockTime: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockAddress(address: String, transactions: Seq[BlockAddressTx])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockAddressTx(txHash: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BlockInfo(time: Long, height: Option[Long], hash: String, slot: Option[Long], epoch: Option[Long], epochSlot: Option[Long], slotLeader: String, size: Long, txCount: Int, previousBlock: Option[String], nextBlock: Option[String], confirmations: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DatumCborResponse(cbor: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DrepInfo(drepId: String, hex: String, amount: Coin, active: Boolean, activeEpoch: Option[Long], hasScript: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EraBound(time: Double, slot: Long, epoch: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EraInfo(start: EraBound, end: Option[EraBound], parameters: EraParameters)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EraParameters(epochLength: Long, slotLength: Double, safeZone: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GenesisInfo(activeSlotsCoefficient: Double, updateQuorum: Int, maxLovelaceSupply: Coin, networkMagic: Int, epochLength: Long, systemStart: Long, slotsPerKesPeriod: Long, slotLength: Long, maxKesEvolutions: Long, securityParam: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HealthClock(serverTime: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HealthStatus(isHealthy: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NetworkInfo(supply: NetworkSupply, stake: NetworkStake)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NetworkStake(live: Coin, active: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NetworkSupply(max: Coin, total: Coin, circulating: Coin, locked: Coin, treasury: Coin, reserves: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolDelegator(address: String, liveStake: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolExtended(poolId: String, hex: String, activeStake: Option[Coin] = ..., liveStake: Option[Coin] = ..., liveSize: Option[Double] = ..., liveSaturation: Option[Double] = ..., liveDelegators: Option[Long] = ..., activeSize: Option[Double] = ..., blocks: Option[Long] = ..., registration: Option[Seq[String]] = ..., retirement: Option[Seq[String]] = ...)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolHistoryEntry(epoch: Long, blocks: Long, activeStake: Coin, activeSize: Double, delegatorsCount: Long, rewards: Coin, fees: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolMetadataRef(url: Option[String], hash: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class PoolRelay(ipv4: Option[String], ipv6: Option[String], dns: Option[String], dnsSrv: Option[String], port: Option[Int])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Quantity

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Quantity.type
case class ScriptCborResponse(cbor: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ScriptInfo(scriptHash: String, scriptType: String, serialisedSize: Option[Long])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionDelegation(index: Int, certIndex: Int, address: String, poolId: String, activeEpoch: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionInfo(hash: String, block: String, blockHeight: Long, blockTime: Long, slot: Long, index: Int, fees: Coin, size: Long, invalidBefore: Option[String], invalidHereafter: Option[String], utxoCount: Int, redeemerCount: Int, outputAmount: Seq[AssetAmount], validContract: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionMetadataCborEntry(label: String, cborMetadata: Option[String], metadata: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionMetadataEntry(label: String, jsonMetadata: Value)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionMir(pot: String, certIndex: Int, address: String, amount: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionPoolRetire(certIndex: Int, poolId: String, retiringEpoch: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionPoolUpdate(certIndex: Int, poolId: String, vrfKey: String, pledge: Coin, marginCost: Double, fixedCost: Coin, rewardAccount: String, owners: Seq[String], metadata: Option[PoolMetadataRef], relays: Seq[PoolRelay], activeEpoch: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionRedeemer(txIndex: Int, purpose: String, scriptHash: String, redeemerDataHash: String, unitMem: Quantity, unitSteps: Quantity, fee: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionStake(certIndex: Int, address: String, registration: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TransactionWithdrawal(address: String, amount: Coin)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TxMetadataCbor(txHash: String, cborMetadata: Option[String], metadata: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TxMetadataJson(txHash: String, jsonMetadata: Value)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

opaque type Quantity

String-encoded quantity from Blockfrost API. Used for non-ADA numeric fields that Blockfrost returns as JSON strings (asset quantities, execution unit budgets, voting power).

String-encoded quantity from Blockfrost API. Used for non-ADA numeric fields that Blockfrost returns as JSON strings (asset quantities, execution unit budgets, voting power).

For ADA/lovelace amounts, use Coin instead.

Attributes

Generated with