|
16 | 16 | -- This module provides the client side of the node-to-client IPC protocol |
17 | 17 | -- used to communicate with a local Cardano node. This can be used to |
18 | 18 | -- query the node for information, to submit transactions, and even to |
19 | | --- get historical information aobut the chain by using the |
| 19 | +-- get historical information about the chain by using the |
20 | 20 | -- 'ChainSync' protocol. |
21 | 21 | module Cardano.Api.Internal.IPC |
22 | 22 | ( -- * Examples |
@@ -59,10 +59,10 @@ module Cardano.Api.Internal.IPC |
59 | 59 | -- the @shelley-genesis.json@ file that the node is using to connect to the |
60 | 60 | -- network. For the preview network, this is currently @86_400@. |
61 | 61 | -- * In the case we are connecting to a testnet, we also need to find out |
62 | | - -- the magic number for the network the node is connected to. This can be |
| 62 | + -- the network identifier for the network the node is connected to. This can be |
63 | 63 | -- obtained by looking for the @networkMagic@ key in the @shelley-genesis.json@ |
64 | 64 | -- file that the node is using to connect to the network. For the preview |
65 | | - -- network, the magic number is currently @2@. |
| 65 | + -- network, the network identifier is currently @2@. |
66 | 66 | -- * The path to the socket file of the node. This can be set when starting the |
67 | 67 | -- node by using the @--socket-path@ parameter. By default it can usually be |
68 | 68 | -- found in the @db@ subfolder of the node's working directory. |
@@ -98,7 +98,7 @@ module Cardano.Api.Internal.IPC |
98 | 98 | -- eEra <- runExceptT $ Api.queryNodeLocalState connectionInfo Network.VolatileTip Api.QueryCurrentEra |
99 | 99 | -- @ |
100 | 100 | -- |
101 | | - -- Here, 'VolatileTip' means we want to get the information out of the most recent node that the |
| 101 | + -- Here, 'VolatileTip' means we want to get the information out of the most recent block that the |
102 | 102 | -- node is aware of. The disadvantage is that the information we get may potentially be rolled back |
103 | 103 | -- and stop being valid. We need to account for this. Alternatively, we can use 'ImmutableTip' to |
104 | 104 | -- obtain the information from the most recent block that is assumed by the consensus algorithm |
@@ -163,7 +163,7 @@ module Cardano.Api.Internal.IPC |
163 | 163 |
|
164 | 164 | -- ** Submitting a transaction |
165 | 165 |
|
166 | | - -- | Let's assume we have a signed transaction of the right era that we want to submit to the node, |
| 166 | + -- | Let's assume we have a signed transaction of the latest era that we want to submit to the node, |
167 | 167 | -- and that it is in the variable @signedTx@ of type @Tx era@. |
168 | 168 | -- |
169 | 169 | -- You can find out how to make such a transaction by looking at the documentation of the |
|
0 commit comments