Skip to content

Commit 9ba65cd

Browse files
committed
Add clarifications
1 parent 3705795 commit 9ba65cd

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

cardano-api/cardano-api.cabal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ library
7373
Cardano.Api.Experimental
7474
Cardano.Api.Internal.Address
7575
Cardano.Api.Internal.Block
76+
Cardano.Api.Internal.Convenience.Query
7677
Cardano.Api.Internal.DRepMetadata
7778
Cardano.Api.Internal.Eon.ShelleyBasedEra
7879
Cardano.Api.Internal.Eras
@@ -191,7 +192,6 @@ library
191192
Cardano.Api.Internal.Certificate
192193
Cardano.Api.Internal.Compatible.Tx
193194
Cardano.Api.Internal.Convenience.Construction
194-
Cardano.Api.Internal.Convenience.Query
195195
Cardano.Api.Internal.DeserialiseAnyOf
196196
Cardano.Api.Internal.Eon.AllegraEraOnwards
197197
Cardano.Api.Internal.Eon.AlonzoEraOnwards

cardano-api/src/Cardano/Api/Internal/IPC.hs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ module Cardano.Api.Internal.IPC
5757
-- * The number of slots per epoch for the network the node is connected to.
5858
-- We can obtain this information by looking for the @epochLength@ key in
5959
-- the @shelley-genesis.json@ file that the node is using to connect to the
60-
-- network. For the preview network, this is currently @86_400@.
60+
-- network. For the preview network, at the time of writing, it is @86_400@,
61+
-- but it can change. This value, and other genesis parameters, can also be
62+
-- queried by using the 'QueryGenesisParameters' query.
6163
-- * In the case we are connecting to a testnet, we also need to find out
6264
-- the network identifier for the network the node is connected to. This can be
6365
-- obtained by looking for the @networkMagic@ key in the @shelley-genesis.json@
@@ -159,6 +161,8 @@ module Cardano.Api.Internal.IPC
159161
-- Left Shelley.AFPointNotOnChain -> error "Error, point queried is not on chain!"
160162
-- @
161163
--
164+
-- Alternatively, to avoid having nested result types, we can also use the convenience
165+
-- functions and types from "Cardano.Api.Internal.Convenience.Query".
162166
-- The obtained @utxo@ is a standard @Map@ of type @Map TxIn (TxOut CtxUTxO era)@.
163167

164168
-- ** Submitting a transaction

0 commit comments

Comments
 (0)