Safe Haskell	None
Language	Haskell2010

Cardano.Api.IPC

Contents

Node interaction
- Modes

Description

Node IPC protocols

Synopsis

connectToLocalNode :: LocalNodeConnectInfo -> LocalNodeClientProtocolsInMode -> IO ()
connectToLocalNodeWithVersion :: LocalNodeConnectInfo -> (NodeToClientVersion -> LocalNodeClientProtocolsInMode) -> IO ()
data LocalNodeConnectInfo = LocalNodeConnectInfo {
- localConsensusModeParams :: ConsensusModeParams
- localNodeNetworkId :: NetworkId
- localNodeSocketPath :: SocketPath
}
data LocalNodeClientParams where
- LocalNodeClientParamsSingleBlock :: (ProtocolClient block, LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto))) => ProtocolClientInfoArgs block -> (NodeToClientVersion -> LocalNodeClientProtocolsForBlock block) -> LocalNodeClientParams
- LocalNodeClientParamsCardano :: (ProtocolClient block, CardanoHardForkConstraints (ConsensusCryptoForBlock block)) => ProtocolClientInfoArgs block -> (NodeToClientVersion -> LocalNodeClientProtocolsForBlock block) -> LocalNodeClientParams
mkLocalNodeClientParams :: forall block. CardanoBlock StandardCrypto ~ block => ConsensusModeParams -> (NodeToClientVersion -> LocalNodeClientProtocolsInMode) -> LocalNodeClientParams
data LocalNodeClientProtocols block point tip slot tx txid txerr query m = LocalNodeClientProtocols {
- localChainSyncClient :: LocalChainSyncClient block point tip m
- localTxSubmissionClient :: Maybe (LocalTxSubmissionClient tx txerr m ())
- localStateQueryClient :: Maybe (LocalStateQueryClient block point query m ())
- localTxMonitoringClient :: Maybe (LocalTxMonitorClient txid tx slot m ())
}
data LocalChainSyncClient block point tip m
- = NoLocalChainSyncClient
- | LocalChainSyncClientPipelined (ChainSyncClientPipelined block point tip m ())
- | LocalChainSyncClient (ChainSyncClient block point tip m ())
type LocalNodeClientProtocolsInMode = LocalNodeClientProtocols BlockInMode ChainPoint ChainTip SlotNo TxInMode TxIdInMode TxValidationErrorInCardanoMode QueryInMode IO
data ConsensusModeParams where
- CardanoModeParams :: EpochSlots -> ConsensusModeParams
newtype EpochSlots = EpochSlots {
- unEpochSlots :: Word64
}
newtype ChainSyncClient header point tip (m :: Type -> Type) a = ChainSyncClient {
- runChainSyncClient :: m (ClientStIdle header point tip m a)
}
newtype ChainSyncClientPipelined header point tip (m :: Type -> Type) a = ChainSyncClientPipelined {
- runChainSyncClientPipelined :: m (ClientPipelinedStIdle 'Z header point tip m a)
}
data BlockInMode where
- BlockInMode :: CardanoEra era -> Block era -> BlockInMode
newtype LocalTxSubmissionClient tx reject (m :: Type -> Type) a = LocalTxSubmissionClient {
- runLocalTxSubmissionClient :: m (LocalTxClientStIdle tx reject m a)
}
data TxInMode where
- TxInMode :: ShelleyBasedEra era -> Tx era -> TxInMode
- TxInByronSpecial :: GenTx ByronBlock -> TxInMode
data TxValidationErrorInCardanoMode
data TxValidationError era
submitTxToNodeLocal :: LocalNodeConnectInfo -> TxInMode -> IO (SubmitResult TxValidationErrorInCardanoMode)
data SubmitResult reason
- = SubmitSuccess
- | SubmitFail reason
newtype LocalStateQueryClient block point (query :: Type -> Type) (m :: Type -> Type) a = LocalStateQueryClient {
- runLocalStateQueryClient :: m (ClientStIdle block point query m a)
}
data AcquiringFailure
- = AFPointTooOld
- | AFPointNotOnChain
data QueryInMode result where
- QueryCurrentEra :: QueryInMode AnyCardanoEra
- QueryInEra :: QueryInEra era result -> QueryInMode (Either EraMismatch result)
- QueryEraHistory :: QueryInMode EraHistory
- QuerySystemStart :: QueryInMode SystemStart
- QueryChainBlockNo :: QueryInMode (WithOrigin BlockNo)
- QueryChainPoint :: QueryInMode ChainPoint
data QueryInEra era result where
- QueryByronUpdateState :: QueryInEra ByronEra ByronUpdateState
- QueryInShelleyBasedEra :: ShelleyBasedEra era -> QueryInShelleyBasedEra era result -> QueryInEra era result
data QueryInShelleyBasedEra era result where
- QueryEpoch :: QueryInShelleyBasedEra era EpochNo
- QueryGenesisParameters :: QueryInShelleyBasedEra era (GenesisParameters ShelleyEra)
- QueryProtocolParameters :: QueryInShelleyBasedEra era (PParams (ShelleyLedgerEra era))
- QueryProtocolParametersUpdate :: QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
- QueryStakeDistribution :: QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
- QueryUTxO :: QueryUTxOFilter -> QueryInShelleyBasedEra era (UTxO era)
- QueryStakeAddresses :: Set StakeCredential -> NetworkId -> QueryInShelleyBasedEra era (Map StakeAddress Lovelace, Map StakeAddress PoolId)
- QueryStakePools :: QueryInShelleyBasedEra era (Set PoolId)
- QueryStakePoolParameters :: Set PoolId -> QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
- QueryDebugLedgerState :: QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
- QueryProtocolState :: QueryInShelleyBasedEra era (ProtocolState era)
- QueryCurrentEpochState :: QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
- QueryPoolState :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolState era)
- QueryPoolDistribution :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
- QueryStakeSnapshot :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)
- QueryStakeDelegDeposits :: Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential Lovelace)
- QueryConstitution :: QueryInShelleyBasedEra era (Maybe (Constitution (ShelleyLedgerEra era)))
- QueryGovState :: QueryInShelleyBasedEra era (GovState (ShelleyLedgerEra era))
- QueryDRepState :: Set (Credential DRepRole StandardCrypto) -> QueryInShelleyBasedEra era (Map (Credential DRepRole StandardCrypto) (DRepState StandardCrypto))
- QueryDRepStakeDistr :: Set (DRep StandardCrypto) -> QueryInShelleyBasedEra era (Map (DRep StandardCrypto) Lovelace)
- QueryCommitteeMembersState :: Set (Credential ColdCommitteeRole StandardCrypto) -> Set (Credential HotCommitteeRole StandardCrypto) -> Set MemberStatus -> QueryInShelleyBasedEra era (Maybe (CommitteeMembersState StandardCrypto))
- QueryStakeVoteDelegatees :: Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential (DRep StandardCrypto))
queryNodeLocalState :: forall result. LocalNodeConnectInfo -> Maybe ChainPoint -> QueryInMode result -> IO (Either AcquiringFailure result)
newtype LocalTxMonitorClient txid tx slot (m :: Type -> Type) a = LocalTxMonitorClient {
- runLocalTxMonitorClient :: m (ClientStIdle txid tx slot m a)
}
data LocalTxMonitoringQuery
- = LocalTxMonitoringQueryTx TxIdInMode
- | LocalTxMonitoringSendNextTx
- | LocalTxMonitoringMempoolInformation
data LocalTxMonitoringResult
- = LocalTxMonitoringTxExists TxId SlotNo
- | LocalTxMonitoringTxDoesNotExist TxId SlotNo
- | LocalTxMonitoringNextTx (Maybe TxInMode) SlotNo
- | LocalTxMonitoringMempoolSizeAndCapacity MempoolSizeAndCapacity SlotNo
data MempoolSizeAndCapacity = MempoolSizeAndCapacity {
- capacityInBytes :: !Word32
- sizeInBytes :: !Word32
- numberOfTxs :: !Word32
}
queryTxMonitoringLocal :: LocalNodeConnectInfo -> LocalTxMonitoringQuery -> IO LocalTxMonitoringResult
data EraHistory where
- EraHistory :: CardanoBlock StandardCrypto ~ HardForkBlock xs => Interpreter xs -> EraHistory
getProgress :: SlotNo -> EraHistory -> Either PastHorizonException (RelativeTime, SlotLength)
getLocalChainTip :: LocalNodeConnectInfo -> IO ChainTip
toAcquiringFailure :: AcquireFailure -> AcquiringFailure
data NodeToClientVersion
- = NodeToClientV_9
- | NodeToClientV_10
- | NodeToClientV_11
- | NodeToClientV_12
- | NodeToClientV_13
- | NodeToClientV_14
- | NodeToClientV_15
- | NodeToClientV_16
data UnsupportedNtcVersionError = UnsupportedNtcVersionError !MinNodeToClientVersion !NodeToClientVersion

Node interaction

Operations that involve talking to a local Cardano node.

connectToLocalNode :: LocalNodeConnectInfo -> LocalNodeClientProtocolsInMode -> IO () Source #

Establish a connection to a local node and execute the given set of protocol handlers.

connectToLocalNodeWithVersion :: LocalNodeConnectInfo -> (NodeToClientVersion -> LocalNodeClientProtocolsInMode) -> IO () Source #

Establish a connection to a local node and execute the given set of protocol handlers parameterized on the negotiated node-to-client protocol version.

data LocalNodeConnectInfo Source #

Constructors

LocalNodeConnectInfo
Fields localConsensusModeParams :: ConsensusModeParams localNodeNetworkId :: NetworkId localNodeSocketPath :: SocketPath

data LocalNodeClientParams where Source #

This type defines the boundary between the mode-parametrised style used in this API and the block-parametrised style used by the underlying network and consensus libraries.

This interface itself is in the block-parametrised style, with the block type itself being an hidden/existential type.

It bundles together all the necessary class instances, the consensus protocol client identifier, and the set of client side mini-protocol handlers for the node-to-client protocol.

Constructors

LocalNodeClientParamsSingleBlock :: (ProtocolClient block, LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto))) => ProtocolClientInfoArgs block -> (NodeToClientVersion -> LocalNodeClientProtocolsForBlock block) -> LocalNodeClientParams
LocalNodeClientParamsCardano :: (ProtocolClient block, CardanoHardForkConstraints (ConsensusCryptoForBlock block)) => ProtocolClientInfoArgs block -> (NodeToClientVersion -> LocalNodeClientProtocolsForBlock block) -> LocalNodeClientParams

mkLocalNodeClientParams :: forall block. CardanoBlock StandardCrypto ~ block => ConsensusModeParams -> (NodeToClientVersion -> LocalNodeClientProtocolsInMode) -> LocalNodeClientParams Source #

Convert from the mode-parametrised style to the block-parametrised style.

data LocalNodeClientProtocols block point tip slot tx txid txerr query m Source #

The protocols we can use with a local node. Use in conjunction with connectToLocalNode.

These protocols use the types from the rest of this API. The conversion to/from the types used by the underlying wire formats is handled by connectToLocalNode.

Constructors

LocalNodeClientProtocols
Fields localChainSyncClient :: LocalChainSyncClient block point tip m localTxSubmissionClient :: Maybe (LocalTxSubmissionClient tx txerr m ()) localStateQueryClient :: Maybe (LocalStateQueryClient block point query m ()) localTxMonitoringClient :: Maybe (LocalTxMonitorClient txid tx slot m ())

data LocalChainSyncClient block point tip m Source #

Constructors

NoLocalChainSyncClient
LocalChainSyncClientPipelined (ChainSyncClientPipelined block point tip m ())
LocalChainSyncClient (ChainSyncClient block point tip m ())

type LocalNodeClientProtocolsInMode = LocalNodeClientProtocols BlockInMode ChainPoint ChainTip SlotNo TxInMode TxIdInMode TxValidationErrorInCardanoMode QueryInMode IO Source #

Modes

TODO move to Cardano.Api

data ConsensusModeParams where Source #

The consensus-mode-specific parameters needed to connect to a local node that is using each consensus mode.

It is in fact only the Byron era that requires extra parameters, but this is of course inherited by the CardanoMode that uses the Byron era. The reason this parameter is needed stems from unfortunate design decisions from the legacy Byron era. The slots per epoch are needed to be able to decode epoch boundary blocks from the Byron era.

It is possible in future that we may be able to eliminate this parameter by discovering it from the node during the initial handshake.

Constructors

CardanoModeParams :: EpochSlots -> ConsensusModeParams

Instances

Instances details

Show ConsensusModeParams Source #
Instance details Defined in Cardano.Api.Modes Methods showsPrec :: Int -> ConsensusModeParams -> ShowS Source # show :: ConsensusModeParams -> String Source # showList :: [ConsensusModeParams] -> ShowS Source #

newtype EpochSlots #

Constructors

EpochSlots
Fields unEpochSlots :: Word64

Instances

Instances details

Eq EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods (==) :: EpochSlots -> EpochSlots -> Bool Source # (/=) :: EpochSlots -> EpochSlots -> Bool Source #
Data EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EpochSlots -> c EpochSlots Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EpochSlots Source # toConstr :: EpochSlots -> Constr Source # dataTypeOf :: EpochSlots -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EpochSlots) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EpochSlots) Source # gmapT :: (forall b. Data b => b -> b) -> EpochSlots -> EpochSlots Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EpochSlots -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EpochSlots -> r Source # gmapQ :: (forall d. Data d => d -> u) -> EpochSlots -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> EpochSlots -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EpochSlots -> m EpochSlots Source #
Ord EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods compare :: EpochSlots -> EpochSlots -> Ordering Source # (<) :: EpochSlots -> EpochSlots -> Bool Source # (<=) :: EpochSlots -> EpochSlots -> Bool Source # (>) :: EpochSlots -> EpochSlots -> Bool Source # (>=) :: EpochSlots -> EpochSlots -> Bool Source # max :: EpochSlots -> EpochSlots -> EpochSlots Source # min :: EpochSlots -> EpochSlots -> EpochSlots Source #
Read EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods readsPrec :: Int -> ReadS EpochSlots Source # readList :: ReadS [EpochSlots] Source # readPrec :: ReadPrec EpochSlots Source # readListPrec :: ReadPrec [EpochSlots] Source #
Show EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods showsPrec :: Int -> EpochSlots -> ShowS Source # show :: EpochSlots -> String Source # showList :: [EpochSlots] -> ShowS Source #
Generic EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Associated Types type Rep EpochSlots :: Type -> Type Source # Methods from :: EpochSlots -> Rep EpochSlots x Source # to :: Rep EpochSlots x -> EpochSlots Source #
DecCBOR EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods decCBOR :: Decoder s EpochSlots dropCBOR :: Proxy EpochSlots -> Decoder s () label :: Proxy EpochSlots -> Text
EncCBOR EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods encCBOR :: EpochSlots -> Encoding encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy EpochSlots -> Size encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [EpochSlots] -> Size
FromCBOR EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods fromCBOR :: Decoder s EpochSlots # label :: Proxy EpochSlots -> Text #
NoThunks EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods noThunks :: Context -> EpochSlots -> IO (Maybe ThunkInfo) wNoThunks :: Context -> EpochSlots -> IO (Maybe ThunkInfo) showTypeOf :: Proxy EpochSlots -> String
ToCBOR EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods toCBOR :: EpochSlots -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy EpochSlots -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [EpochSlots] -> Size #
Buildable EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots Methods build :: EpochSlots -> Builder
type Rep EpochSlots
Instance details Defined in Cardano.Chain.Slotting.EpochSlots type Rep EpochSlots = D1 ('MetaData "EpochSlots" "Cardano.Chain.Slotting.EpochSlots" "cardano-ledger-byron-1.0.0.3-7XPhaeqCEJ61p5A3PpSRBs" 'True) (C1 ('MetaCons "EpochSlots" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSlots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Chain sync protocol

newtype ChainSyncClient header point tip (m :: Type -> Type) a #

Constructors

ChainSyncClient
Fields runChainSyncClient :: m (ClientStIdle header point tip m a)

newtype ChainSyncClientPipelined header point tip (m :: Type -> Type) a #

Constructors

ChainSyncClientPipelined
Fields runChainSyncClientPipelined :: m (ClientPipelinedStIdle 'Z header point tip m a)

data BlockInMode where Source #

A Block in one of the eras. TODO Rename this to BlockInEra

Constructors

BlockInMode :: CardanoEra era -> Block era -> BlockInMode

Instances

Instances details

Show BlockInMode Source #
Instance details Defined in Cardano.Api.Block Methods showsPrec :: Int -> BlockInMode -> ShowS Source # show :: BlockInMode -> String Source # showList :: [BlockInMode] -> ShowS Source #

Local tx submission

newtype LocalTxSubmissionClient tx reject (m :: Type -> Type) a #

Constructors

LocalTxSubmissionClient
Fields runLocalTxSubmissionClient :: m (LocalTxClientStIdle tx reject m a)

data TxInMode where Source #

A Tx in one of the eras supported by a given protocol mode.

For multi-era modes such as the CardanoMode this type is a sum of the different transaction types for all the eras. It is used in the LocalTxSubmission protocol.

Constructors

TxInMode :: ShelleyBasedEra era -> Tx era -> TxInMode	Shelley based transactions.
TxInByronSpecial :: GenTx ByronBlock -> TxInMode	Legacy Byron transactions and things we can post to the chain which are not actually transactions. This covers: update proposals, votes and delegation certs.

Instances

Instances details

Show TxInMode Source #
Instance details Defined in Cardano.Api.InMode Methods showsPrec :: Int -> TxInMode -> ShowS Source # show :: TxInMode -> String Source # showList :: [TxInMode] -> ShowS Source #

data TxValidationErrorInCardanoMode Source #

A TxValidationError in one of the eras supported by a given protocol mode.

This is used in the LocalStateQuery protocol.

Instances

Instances details

Show TxValidationErrorInCardanoMode Source #
Instance details Defined in Cardano.Api.InMode Methods showsPrec :: Int -> TxValidationErrorInCardanoMode -> ShowS Source # show :: TxValidationErrorInCardanoMode -> String Source # showList :: [TxValidationErrorInCardanoMode] -> ShowS Source #
ToJSON TxValidationErrorInCardanoMode Source #
Instance details Defined in Cardano.Api.InMode Methods toJSON :: TxValidationErrorInCardanoMode -> Value # toEncoding :: TxValidationErrorInCardanoMode -> Encoding # toJSONList :: [TxValidationErrorInCardanoMode] -> Value # toEncodingList :: [TxValidationErrorInCardanoMode] -> Encoding # omitField :: TxValidationErrorInCardanoMode -> Bool #

data TxValidationError era Source #

The transaction validations errors that can occur from trying to submit a transaction to a local node. The errors are specific to an era.

Instances

Instances details

Show (TxValidationError era) Source #
Instance details Defined in Cardano.Api.InMode Methods showsPrec :: Int -> TxValidationError era -> ShowS Source # show :: TxValidationError era -> String Source # showList :: [TxValidationError era] -> ShowS Source #
Generic (TxValidationError era) Source #
Instance details Defined in Cardano.Api.InMode Associated Types type Rep (TxValidationError era) :: Type -> Type Source # Methods from :: TxValidationError era -> Rep (TxValidationError era) x Source # to :: Rep (TxValidationError era) x -> TxValidationError era Source #
ToJSON (TxValidationError era) Source #
Instance details Defined in Cardano.Api.InMode Methods toJSON :: TxValidationError era -> Value # toEncoding :: TxValidationError era -> Encoding # toJSONList :: [TxValidationError era] -> Value # toEncodingList :: [TxValidationError era] -> Encoding # omitField :: TxValidationError era -> Bool #
type Rep (TxValidationError era) Source #
Instance details Defined in Cardano.Api.InMode type Rep (TxValidationError era) = D1 ('MetaData "TxValidationError" "Cardano.Api.InMode" "cardano-api-8.36.1.1-1nzPjfRAlyMHXWNqpMkUqi-internal" 'False) (C1 ('MetaCons "ByronTxValidationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ApplyTxErr ByronBlock))) :+: C1 ('MetaCons "ShelleyTxValidationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ShelleyBasedEra era)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ApplyTxErr (ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era))))))

submitTxToNodeLocal :: LocalNodeConnectInfo -> TxInMode -> IO (SubmitResult TxValidationErrorInCardanoMode) Source #

data SubmitResult reason #

Constructors

SubmitSuccess
SubmitFail reason

Instances

Instances details

Functor SubmitResult
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods fmap :: (a -> b) -> SubmitResult a -> SubmitResult b Source # (<$) :: a -> SubmitResult b -> SubmitResult a Source #
Eq reason => Eq (SubmitResult reason)
Instance details Defined in Ouroboros.Network.Protocol.LocalTxSubmission.Type Methods (==) :: SubmitResult reason -> SubmitResult reason -> Bool Source # (/=) :: SubmitResult reason -> SubmitResult reason -> Bool Source #

Local state query

newtype LocalStateQueryClient block point (query :: Type -> Type) (m :: Type -> Type) a #

Constructors

LocalStateQueryClient
Fields runLocalStateQueryClient :: m (ClientStIdle block point query m a)

data AcquiringFailure Source #

Establish a connection to a node and execute a single query using the local state query protocol.

Constructors

AFPointTooOld
AFPointNotOnChain

Instances

Instances details

Eq AcquiringFailure Source #
Instance details Defined in Cardano.Api.IPC Methods (==) :: AcquiringFailure -> AcquiringFailure -> Bool Source # (/=) :: AcquiringFailure -> AcquiringFailure -> Bool Source #
Show AcquiringFailure Source #
Instance details Defined in Cardano.Api.IPC Methods showsPrec :: Int -> AcquiringFailure -> ShowS Source # show :: AcquiringFailure -> String Source # showList :: [AcquiringFailure] -> ShowS Source #

data QueryInMode result where Source #

Constructors

QueryCurrentEra :: QueryInMode AnyCardanoEra
QueryInEra :: QueryInEra era result -> QueryInMode (Either EraMismatch result)
QueryEraHistory :: QueryInMode EraHistory
QuerySystemStart :: QueryInMode SystemStart
QueryChainBlockNo :: QueryInMode (WithOrigin BlockNo)
QueryChainPoint :: QueryInMode ChainPoint

Instances

Instances details

Show (QueryInMode result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInMode result -> ShowS Source # show :: QueryInMode result -> String Source # showList :: [QueryInMode result] -> ShowS Source #
NodeToClientVersionOf (QueryInMode result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInMode result -> NodeToClientVersion Source #

data QueryInEra era result where Source #

Constructors

QueryByronUpdateState :: QueryInEra ByronEra ByronUpdateState
QueryInShelleyBasedEra :: ShelleyBasedEra era -> QueryInShelleyBasedEra era result -> QueryInEra era result

Instances

Instances details

Show (QueryInEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInEra era result -> ShowS Source # show :: QueryInEra era result -> String Source # showList :: [QueryInEra era result] -> ShowS Source #
NodeToClientVersionOf (QueryInEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInEra era result -> NodeToClientVersion Source #

data QueryInShelleyBasedEra era result where Source #

Constructors

QueryEpoch :: QueryInShelleyBasedEra era EpochNo
QueryGenesisParameters :: QueryInShelleyBasedEra era (GenesisParameters ShelleyEra)
QueryProtocolParameters :: QueryInShelleyBasedEra era (PParams (ShelleyLedgerEra era))
QueryProtocolParametersUpdate :: QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
QueryStakeDistribution :: QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
QueryUTxO :: QueryUTxOFilter -> QueryInShelleyBasedEra era (UTxO era)
QueryStakeAddresses :: Set StakeCredential -> NetworkId -> QueryInShelleyBasedEra era (Map StakeAddress Lovelace, Map StakeAddress PoolId)
QueryStakePools :: QueryInShelleyBasedEra era (Set PoolId)
QueryStakePoolParameters :: Set PoolId -> QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
QueryDebugLedgerState :: QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
QueryProtocolState :: QueryInShelleyBasedEra era (ProtocolState era)
QueryCurrentEpochState :: QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
QueryPoolState :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolState era)
QueryPoolDistribution :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
QueryStakeSnapshot :: Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)
QueryStakeDelegDeposits :: Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential Lovelace)
QueryConstitution :: QueryInShelleyBasedEra era (Maybe (Constitution (ShelleyLedgerEra era)))
QueryGovState :: QueryInShelleyBasedEra era (GovState (ShelleyLedgerEra era))
QueryDRepState :: Set (Credential DRepRole StandardCrypto) -> QueryInShelleyBasedEra era (Map (Credential DRepRole StandardCrypto) (DRepState StandardCrypto))
QueryDRepStakeDistr :: Set (DRep StandardCrypto) -> QueryInShelleyBasedEra era (Map (DRep StandardCrypto) Lovelace)
QueryCommitteeMembersState :: Set (Credential ColdCommitteeRole StandardCrypto) -> Set (Credential HotCommitteeRole StandardCrypto) -> Set MemberStatus -> QueryInShelleyBasedEra era (Maybe (CommitteeMembersState StandardCrypto))
QueryStakeVoteDelegatees :: Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential (DRep StandardCrypto))

Instances

Instances details

Show (QueryInShelleyBasedEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInShelleyBasedEra era result -> ShowS Source # show :: QueryInShelleyBasedEra era result -> String Source # showList :: [QueryInShelleyBasedEra era result] -> ShowS Source #
NodeToClientVersionOf (QueryInShelleyBasedEra era result) Source #	Mapping for queries in Shelley-based eras returning minimal node-to-client protocol versions. More information about queries versioning can be found: * https://input-output-hk.github.io/ouroboros-network/ouroboros-network/Ouroboros-Network-NodeToClient.html#t:NodeToClientVersion * https://input-output-hk.github.io/ouroboros-consensus/docs/for-developers/QueryVersioning/#implementation
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInShelleyBasedEra era result -> NodeToClientVersion Source #

queryNodeLocalState :: forall result. LocalNodeConnectInfo -> Maybe ChainPoint -> QueryInMode result -> IO (Either AcquiringFailure result) Source #

Local tx monitoring

newtype LocalTxMonitorClient txid tx slot (m :: Type -> Type) a #

Constructors

LocalTxMonitorClient
Fields runLocalTxMonitorClient :: m (ClientStIdle txid tx slot m a)

data LocalTxMonitoringQuery Source #

Constructors

LocalTxMonitoringQueryTx TxIdInMode	Query if a particular tx exists in the mempool. Note that, the absence of a transaction does not imply anything about how the transaction was processed: it may have been dropped, or inserted in a block.
LocalTxMonitoringSendNextTx	The mempool is modeled as an ordered list of transactions and thus, can be traversed linearly. `LocalTxMonitoringSendNextTx` requests the next transaction from the current list. This must be a transaction that was not previously sent to the client for this particular snapshot.
LocalTxMonitoringMempoolInformation	Ask the server about the current mempool's capacity and sizes. This is fixed in a given snapshot.

data LocalTxMonitoringResult Source #

Constructors

LocalTxMonitoringTxExists TxId SlotNo	Slot number at which the mempool snapshot was taken
LocalTxMonitoringTxDoesNotExist TxId SlotNo	Slot number at which the mempool snapshot was taken
LocalTxMonitoringNextTx (Maybe TxInMode) SlotNo	Slot number at which the mempool snapshot was taken
LocalTxMonitoringMempoolSizeAndCapacity MempoolSizeAndCapacity SlotNo	Slot number at which the mempool snapshot was taken

Instances

Instances details

ToJSON LocalTxMonitoringResult Source #
Instance details Defined in Cardano.Api.IPC Methods toJSON :: LocalTxMonitoringResult -> Value # toEncoding :: LocalTxMonitoringResult -> Encoding # toJSONList :: [LocalTxMonitoringResult] -> Value # toEncodingList :: [LocalTxMonitoringResult] -> Encoding # omitField :: LocalTxMonitoringResult -> Bool #

data MempoolSizeAndCapacity #

Constructors

MempoolSizeAndCapacity
Fields capacityInBytes :: !Word32 sizeInBytes :: !Word32 numberOfTxs :: !Word32

Instances

Instances details

Eq MempoolSizeAndCapacity
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods (==) :: MempoolSizeAndCapacity -> MempoolSizeAndCapacity -> Bool Source # (/=) :: MempoolSizeAndCapacity -> MempoolSizeAndCapacity -> Bool Source #
Show MempoolSizeAndCapacity
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Methods showsPrec :: Int -> MempoolSizeAndCapacity -> ShowS Source # show :: MempoolSizeAndCapacity -> String Source # showList :: [MempoolSizeAndCapacity] -> ShowS Source #
Generic MempoolSizeAndCapacity
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type Associated Types type Rep MempoolSizeAndCapacity :: Type -> Type Source # Methods from :: MempoolSizeAndCapacity -> Rep MempoolSizeAndCapacity x Source # to :: Rep MempoolSizeAndCapacity x -> MempoolSizeAndCapacity Source #
type Rep MempoolSizeAndCapacity
Instance details Defined in Ouroboros.Network.Protocol.LocalTxMonitor.Type type Rep MempoolSizeAndCapacity = D1 ('MetaData "MempoolSizeAndCapacity" "Ouroboros.Network.Protocol.LocalTxMonitor.Type" "ouroboros-network-protocols-0.6.0.1-5nxaatHDNPs97mNVEagje7" 'False) (C1 ('MetaCons "MempoolSizeAndCapacity" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityInBytes") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32) :: (S1 ('MetaSel ('Just "sizeInBytes") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32) :: S1 ('MetaSel ('Just "numberOfTxs") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32))))

queryTxMonitoringLocal :: LocalNodeConnectInfo -> LocalTxMonitoringQuery -> IO LocalTxMonitoringResult Source #

data EraHistory where Source #

Constructors

EraHistory :: CardanoBlock StandardCrypto ~ HardForkBlock xs => Interpreter xs -> EraHistory

getProgress :: SlotNo -> EraHistory -> Either PastHorizonException (RelativeTime, SlotLength) Source #

Common queries

getLocalChainTip :: LocalNodeConnectInfo -> IO ChainTip Source #

Helpers

toAcquiringFailure :: AcquireFailure -> AcquiringFailure Source #

data NodeToClientVersion #

Constructors

NodeToClientV_9
NodeToClientV_10
NodeToClientV_11
NodeToClientV_12
NodeToClientV_13
NodeToClientV_14
NodeToClientV_15
NodeToClientV_16

Instances

Instances details

Bounded NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods minBound :: NodeToClientVersion Source # maxBound :: NodeToClientVersion Source #
Enum NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods succ :: NodeToClientVersion -> NodeToClientVersion Source # pred :: NodeToClientVersion -> NodeToClientVersion Source # toEnum :: Int -> NodeToClientVersion Source # fromEnum :: NodeToClientVersion -> Int Source # enumFrom :: NodeToClientVersion -> [NodeToClientVersion] Source # enumFromThen :: NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] Source # enumFromTo :: NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] Source # enumFromThenTo :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion -> [NodeToClientVersion] Source #
Eq NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods (==) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source # (/=) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source #
Ord NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods compare :: NodeToClientVersion -> NodeToClientVersion -> Ordering Source # (<) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source # (<=) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source # (>) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source # (>=) :: NodeToClientVersion -> NodeToClientVersion -> Bool Source # max :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion Source # min :: NodeToClientVersion -> NodeToClientVersion -> NodeToClientVersion Source #
Show NodeToClientVersion
Instance details Defined in Ouroboros.Network.NodeToClient.Version Methods showsPrec :: Int -> NodeToClientVersion -> ShowS Source # show :: NodeToClientVersion -> String Source # showList :: [NodeToClientVersion] -> ShowS Source #
MonadReader NodeToClientVersion (LocalStateQueryExpr block point query r m)
Instance details Defined in Cardano.Api.IPC.Monad Methods ask :: LocalStateQueryExpr block point query r m NodeToClientVersion local :: (NodeToClientVersion -> NodeToClientVersion) -> LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m a reader :: (NodeToClientVersion -> a) -> LocalStateQueryExpr block point query r m a

data UnsupportedNtcVersionError Source #

Constructors

UnsupportedNtcVersionError !MinNodeToClientVersion !NodeToClientVersion

Instances

Instances details

Eq UnsupportedNtcVersionError Source #
Instance details Defined in Cardano.Api.IPC.Version Methods (==) :: UnsupportedNtcVersionError -> UnsupportedNtcVersionError -> Bool Source # (/=) :: UnsupportedNtcVersionError -> UnsupportedNtcVersionError -> Bool Source #
Show UnsupportedNtcVersionError Source #
Instance details Defined in Cardano.Api.IPC.Version Methods showsPrec :: Int -> UnsupportedNtcVersionError -> ShowS Source # show :: UnsupportedNtcVersionError -> String Source # showList :: [UnsupportedNtcVersionError] -> ShowS Source #