diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# Version [0.10.0.0](https://github.com/blockfrost/blockfrost-haskell/compare/client-0.9.2.0...client-0.10.0.0) (2025-06-03) + +* Additions + * Governance support [#77](https://github.com/blockfrost/blockfrost-haskell/pull/77) + * `AccountInfo` extended with `drepId` field [#77](https://github.com/blockfrost/blockfrost-haskell/pull/77) + # Version [0.9.2.0](https://github.com/blockfrost/blockfrost-haskell/compare/client-0.9.1.0...client-0.9.2.0) (2025-04-07) * Additions diff --git a/blockfrost-client.cabal b/blockfrost-client.cabal --- a/blockfrost-client.cabal +++ b/blockfrost-client.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: blockfrost-client -version: 0.9.2.0 +version: 0.10.0.0 synopsis: blockfrost.io basic client description: Simple Blockfrost clients for use with transformers or mtl homepage: https://github.com/blockfrost/blockfrost-haskell @@ -57,6 +57,7 @@ , Blockfrost.Client.Cardano.Assets , Blockfrost.Client.Cardano.Blocks , Blockfrost.Client.Cardano.Epochs + , Blockfrost.Client.Cardano.Governance , Blockfrost.Client.Cardano.Ledger , Blockfrost.Client.Cardano.Mempool , Blockfrost.Client.Cardano.Metadata @@ -68,7 +69,7 @@ , Blockfrost.Client.IPFS , Blockfrost.Client.NutLink build-depends: base >= 4.7 && < 5 - , blockfrost-api >= 0.12.2 + , blockfrost-api >= 0.13 , blockfrost-client-core ^>= 0.6 , bytestring , directory diff --git a/src/Blockfrost/Client.hs b/src/Blockfrost/Client.hs --- a/src/Blockfrost/Client.hs +++ b/src/Blockfrost/Client.hs @@ -92,6 +92,25 @@ , getEpochBlocksByPool , getEpochBlocksByPool' , getEpochProtocolParams + -- Cardano - Governance + , getDReps + , getDReps' + , getDRep + , getDRepDelegators + , getDRepDelegators' + , getDRepMetadata + , getDRepUpdates + , getDRepUpdates' + , getDRepVotes + , getDRepVotes' + , getProposals + , getProposals' + , getProposal + , getParamProposal + , getWithdrawalProposal + , getProposalVotes + , getProposalVotes' + , getProposalMetadata -- Cardano - Ledger , getLedgerGenesis -- Cardano - Metadata @@ -185,6 +204,7 @@ import Blockfrost.Client.Cardano.Assets import Blockfrost.Client.Cardano.Blocks import Blockfrost.Client.Cardano.Epochs +import Blockfrost.Client.Cardano.Governance import Blockfrost.Client.Cardano.Ledger import Blockfrost.Client.Cardano.Mempool import Blockfrost.Client.Cardano.Metadata diff --git a/src/Blockfrost/Client/Cardano/Governance.hs b/src/Blockfrost/Client/Cardano/Governance.hs new file mode 100644 --- /dev/null +++ b/src/Blockfrost/Client/Cardano/Governance.hs @@ -0,0 +1,167 @@ +-- | Governance queries + +module Blockfrost.Client.Cardano.Governance + ( getDReps + , getDReps' + , getDRep + , getDRepDelegators + , getDRepDelegators' + , getDRepMetadata + , getDRepUpdates + , getDRepUpdates' + , getDRepVotes + , getDRepVotes' + , getProposals + , getProposals' + , getProposal + , getParamProposal + , getWithdrawalProposal + , getProposalVotes + , getProposalVotes' + , getProposalMetadata + ) where + +import Blockfrost.API +import Blockfrost.Client.Types +import Blockfrost.Types + +governanceClient :: MonadBlockfrost m => Project -> GovernanceAPI (AsClientT m) +governanceClient = fromServant . _governance . cardanoClient + +getDReps_ :: MonadBlockfrost m => Project -> Paged -> SortOrder -> m [DRep] +getDReps_ = _dreps . governanceClient + +-- | Return the information about Delegate Representatives (DReps). +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getDReps' :: MonadBlockfrost m => Paged -> SortOrder -> m [DRep] +getDReps' pg s = go (\p -> getDReps_ p pg s) + +-- | Return the information about Delegate Representatives (DReps). +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getDReps :: MonadBlockfrost m => m [DRep] +getDReps = getDReps' def def + +getDRep_ :: MonadBlockfrost m => Project -> DRepId -> m DRepInfo +getDRep_ = _drep . governanceClient + +-- | Return the information about specific Delegate Representative (DRep). +getDRep :: MonadBlockfrost m => DRepId -> m DRepInfo +getDRep d = go (`getDRep_` d) + +getDRepDelegators_ :: MonadBlockfrost m => Project -> DRepId -> Paged -> SortOrder -> m [DRepDelegator] +getDRepDelegators_ = _drepDelegators . governanceClient + +-- | Get a list of DRep delegators +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getDRepDelegators' :: MonadBlockfrost m => DRepId -> Paged -> SortOrder -> m [DRepDelegator] +getDRepDelegators' d pg s = go (\p -> getDRepDelegators_ p d pg s) + +-- | Get a list of DRep delegators +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getDRepDelegators :: MonadBlockfrost m => DRepId -> m [DRepDelegator] +getDRepDelegators d = getDRepDelegators' d def def + +getDRepMetadata_ :: MonadBlockfrost m => Project -> DRepId -> m DRepMeta +getDRepMetadata_ = _drepMetadata . governanceClient + +-- | Get DRep metadata information. +getDRepMetadata :: MonadBlockfrost m => DRepId -> m DRepMeta +getDRepMetadata d = go (`getDRepMetadata_` d) + +getDRepUpdates_ :: MonadBlockfrost m => Project -> DRepId -> Paged -> SortOrder -> m [DRepUpdate] +getDRepUpdates_ = _drepUpdates . governanceClient + +-- | Get a list of certificate updates to the DRep. +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getDRepUpdates' :: MonadBlockfrost m => DRepId -> Paged -> SortOrder -> m [DRepUpdate] +getDRepUpdates' d pg s = go (\p -> getDRepUpdates_ p d pg s) + +-- | Get a list of certificate updates to the DRep. +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getDRepUpdates :: MonadBlockfrost m => DRepId -> m [DRepUpdate] +getDRepUpdates d = getDRepUpdates' d def def + +getDRepVotes_ :: MonadBlockfrost m => Project -> DRepId -> Paged -> SortOrder -> m [DRepVote] +getDRepVotes_ = _drepVotes . governanceClient + +-- | Get a history of DReps votes. +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getDRepVotes' :: MonadBlockfrost m => DRepId -> Paged -> SortOrder -> m [DRepVote] +getDRepVotes' d pg s = go (\p -> getDRepVotes_ p d pg s) + +-- | Get a history of DReps votes. +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getDRepVotes :: MonadBlockfrost m => DRepId -> m [DRepVote] +getDRepVotes d = getDRepVotes' d def def + +getProposals_ :: MonadBlockfrost m => Project -> Paged -> SortOrder -> m [Proposal] +getProposals_ = _proposals . governanceClient + +-- | Get a history of DReps proposals. +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getProposals' :: MonadBlockfrost m => Paged -> SortOrder -> m [Proposal] +getProposals' pg s = go (\p -> getProposals_ p pg s) + +-- | Get a history of DReps proposals. +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getProposals :: MonadBlockfrost m => m [Proposal] +getProposals = getProposals' def def + +getProposal_ :: MonadBlockfrost m => Project -> TxHash -> Integer -> m ProposalInfo +getProposal_ = _proposal . governanceClient + +-- | Get a proposal details. +getProposal :: MonadBlockfrost m => TxHash -> Integer -> m ProposalInfo +getProposal txHash certIdx = go (\p -> getProposal_ p txHash certIdx) + +getParamProposal_ :: MonadBlockfrost m => Project -> TxHash -> Integer -> m ParamProposal +getParamProposal_ = _paramProposal . governanceClient + +-- | Get a parameter proposal details. +getParamProposal :: MonadBlockfrost m => TxHash -> Integer -> m ParamProposal +getParamProposal txHash certIdx = go (\p -> getParamProposal_ p txHash certIdx) + +getWithdrawalProposal_ :: MonadBlockfrost m => Project -> TxHash -> Integer -> m [WithdrawalProposal] +getWithdrawalProposal_ = _withdrawalProposal . governanceClient + +-- | Get a witdhrawal proposal details. +getWithdrawalProposal :: MonadBlockfrost m => TxHash -> Integer -> m [WithdrawalProposal] +getWithdrawalProposal txHash certIdx = go (\p -> getWithdrawalProposal_ p txHash certIdx) + +getProposalVotes_ :: MonadBlockfrost m => Project -> TxHash -> Integer -> Paged -> SortOrder -> m [ProposalVote] +getProposalVotes_ = _proposalVotes . governanceClient + +-- | Get a history of DReps proposals. +-- Allows custom paging and ordering using 'Paged' and 'SortOrder'. +getProposalVotes' :: MonadBlockfrost m => TxHash -> Integer -> Paged -> SortOrder -> m [ProposalVote] +getProposalVotes' txHash certIdx pg s = go (\p -> getProposalVotes_ p txHash certIdx pg s) + +-- | Get a history of DReps proposals. +-- +-- Queries 100 entries. To query all entries use 'Blockfrost.Client.Core.allPages' +-- with principled variant of this function (suffixed with @'@) +-- that accepts 'Paged' argument. +getProposalVotes :: MonadBlockfrost m => TxHash -> Integer -> m [ProposalVote] +getProposalVotes txHash certIdx = getProposalVotes' txHash certIdx def def + +getProposalMetadata_ :: MonadBlockfrost m => Project -> TxHash -> Integer -> m ProposalMeta +getProposalMetadata_ = _proposalMeta . governanceClient + +-- | Get a parameter proposal details. +getProposalMetadata :: MonadBlockfrost m => TxHash -> Integer -> m ProposalMeta +getProposalMetadata txHash certIdx = go (\p -> getProposalMetadata_ p txHash certIdx)