Changelog for blockfrost-api-0.12.0.0

Version 0.12.0.0 (2024-09-19)

Additions
- ProtocolParams extended with Conway related protocol parameters and raw cost models #59
- Mempool endpoints #62
- /txs/:hash/cbor endpoint with TransactionCBOR data type #63

Version 0.11.0.0 (2024-08-26)

Changes

ScriptType
- adds PlutusV3 #54

Version 0.10.0.0 (2024-02-16)

Fixed
- Handling of Ogmios v5 txEvaluate response #52
  - TxEvalResult is no more and instead we add TxEvalValidator and TxEvalFailure. TxEval newtype now has a single result field of type Either TxEvalFailure (Map TxEvalValidator TxEvalBudget)

Version 0.9.0.0 (2023-12-18)

Allow servant 0.20 #41
Additions #43
- Env enum extended with Sanchonet for cardano-sanchonet network
- /accounts/:stake_address/addresses/total endpoint and AddressAssociatedTotal type
- /addresses/:address/extended endpoint and AddressInfoExtended type (uses AmountExtended type)
- /pools/extended endpoint and Pool type
- /utils API
  - /utils/addresses/xpub/:xpub/:role/:index endpoint and DerivedAddress type
  - /utils/txs/evaluate endpoint
  - /utils/txs/evaluate/utxos endpoint
  - TxEval, TxEvalResult, TxEvalBudget, TxEvalInput types for the two above
Better metadata handling #40
- Adds onchainMetadataExtra and onchainMetadataValue fields for AssetDetails

Version 0.8.1.0 (2023-09-18)

Added address field to AddressUtxo #38

Version 0.8.0.0 (2023-01-10)

Removed
- Arbitrary instances for POSIXMillis, ServerTime
- quickcheck-instances dependency and its propagated instances #35

Version 0.7.1.0 (2023-01-03)

Additions
- NetworkEraSummary, NetworkEraBound, NetworkEraParameters types and _networkEras endpoint #33
- ToSample ScriptHashList instance

Version 0.7.0.0 (2022-10-11)

Changes
- Added ScriptHashList newtype instead of overlapping instance for [ScriptHash] which is used as a result of _listScripts in ScriptsAPI

Version 0.6.0.0 (2022-08-31)

Additions
- AccountReward now contains additional type field refering to RewardType
- AssetTransaction grows blockTime field
- PoolInfo grows blocksEpoch field with number of blocks minted in the current epoch
- Vasil related
  - ScriptDatumCBOR type and _getScriptDatumCBOR route
  - Both UtxoInput and UtxoOutput now has
    - inlineDatum field with Maybe InlineDatum type
    - referenceScriptHash field with Maybe ScriptHash type
  - UtxoInput now has reference field indicating that input is a reference input
  - UtxoOutput now has collateral field when UTXO is a collateral output
  - AddressUtxo now also has inlineDatum and referenceScriptHash fields
- CostModels data type which is now returned as part of ProtocolParameters
- Block now has opCert and opCertCounter fields
- Preprod and Preview environments
Changes
- ValidationPurpose type moved from Blockfrost.Types.Cardano.Transactions to Blockfrost.Types.Shared.ValidationPurpose
- dataHash field of AddressUtxo changes type from Maybe Text to Maybe DatumHash
- datumHash field of TransactionRedeemer is now deprecated in favor of redeemerDataHash field
- datumHash field of ScriptRedeemer is now deprecated in favor of redeemerDataHash field
  - and also changes type from Text to DataHash
- ScriptType
  - Plutus type is now PlutusV1
  - adds PlutusV2
- ProtocolParameters
  - coinsPerUtxoWord is now deprecated, prefer coinsPerUtxoSize
  - coinsPerUtxoSize is now
    - Cost per UTxO word for Alonzo.
    - Cost per UTxO byte for Babbage and later.
  - extraEntropy field changes type from Maybe Value to Maybe Text
- ProtocolParams
  - types of following fields changed from Double to Rational
    - a0
    - rho
    - tau
    - decentralisationParam
    - priceMem
    - priceStep
- PoolInfo
  - type of marginCost field changes from Double to Rational
- Genesis
  - type of activeSlotsCoefficient field changes from Double to Rational

Version 0.5.0.0 (2022-06-06)

Fix return type of _getEpochStakeByPool from StakeDistribution to PoolStakeDistribution

Version 0.4.0.1 (2022-04-05)

Allow servant 0.19

Version 0.4.0.0 (2022-03-09)

Changes
- AccountInfo
  - activeEpoch field type changed from Integer to Maybe Integer
- UtxoInput
  - txHash field type changed from Text to TxHash newtype
- TxMetaJSON and TxMetaCBOR
  - txHash field type changed from Text to TxHash newtype

Version 0.3.1.0 (2022-02-17)

Additions
- /blocks/${hash_or_number}/addresses endpoint (Affected addresses in a block)
- blockTime field to AddressTransaction
- Ord instances for Address, AssetId, BlockHash, Epoch, Slot, TxHash
- Enum, Real, Integral for Slot and Epoch

Version 0.3.0.0 (2022-02-07)

Changes
- UtxoInput and UtxoOutput dataHash fields changed from Maybe Text to Maybe DataHash
- TransactionRedeemer
  - scriptHash field changed from Maybe Text to Maybe ScriptHash
  - datumHash field changed from Maybe Text to Maybe DatumHash
Additions
- Transaction grows Boolean validContract field
- Lenses for TransactionRedeemer

Version 0.2.1.0 (2021-11-15)

Additions
- ToSample instances for ScriptDatum, ScriptJSON, ScriptCBOR
- /accounts/{stake_address}/addresses endpoint
- /accounts/{stake_address}/addresses/assets endpoint

Version 0.2.0.0 (2021-10-29)

Breaking changes
- AddressUTXO renamed to AddressUtxo along with its fields
- ProtocolParams collateralPercent field type changed from Double to Integer
- TransactionMetaCBOR now uses metadata field instead of CBORMetadata which holds the same CBOR value as before but without \\x prefix
Alonzo additions
- collateral field to UtxoInput
- redeemerCount field to Transaction
- dataHash field to UtxoInput and UtxoOutput
- dataHash field to AdressUTXO
- outputIndex field to UtxoOutput
- script field to AddressInfo
- datumHash field to ScriptRedeemer
- scriptHash and datumHash field to TransactionRedeemer
- NetworkSupply
  - locked field representing supply locked by all scripts
  - treasury field (current treasury supply)
  - reserves field (current reserves supply)
- /txs/${hash}/redeemers endpoint with TransactionRedeemer and ValidationPurpose types
- Epoch cost model parameters to ProtocolParams
- /scripts endpoint and ScriptHash newtype
- /scripts/${script_hash} endpoint with Script data type
- /scripts/${script_hash}/redeemers endpoint with ScriptRedeemer data type
- /scripts/datum/${datum_hash} endpoint with ScriptDatum data type
- /scripts/${script_hash}/json endpoint with ScriptJSON data type
- /scripts/${script_hash}/cbor endpoint with ScriptCBOR data type
Other
Added liveDelegators field to PoolInfo

Version 0.1.0.0 (2021-09-14)

Initial release

blockfrost-api uses PVP Versioning.