/
API.hs
268 lines (231 loc) · 6.75 KB
/
API.hs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
-- | This module provides a library interface for interacting with Cardano as
-- a user of the system.
--
-- It is intended to be the complete API covering everything but without exposing
-- constructors that reveal any lower level types.
--
-- In the interest of simplicity it glosses over some details of the system.
-- Most simple tools should be able to work just using this interface,
-- however you can go deeper and expose the types from the underlying libraries
-- using "Cardano.Api.Byron" or "Cardano.Api.Shelley".
--
module Cardano.API (
HasTypeProxy(..),
AsType(..),
-- * Cryptographic key interface
-- $keys
Key,
VerificationKey,
SigningKey,
getVerificationKey,
verificationKeyHash,
castVerificationKey,
castSigningKey,
-- ** Generating keys
generateSigningKey,
deterministicSigningKey,
deterministicSigningKeySeedSize,
-- ** Hashes
-- | In Cardano most keys are identified by their hash, and hashes are
-- used in many other places.
Hash,
castHash,
-- * Payment addresses
-- | Constructing and inspecting normal payment addresses
Address,
NetworkId
( Mainnet
, Testnet
),
-- * Byron addresses
makeByronAddress,
ByronKey,
-- * Shelley addresses
makeShelleyAddress,
PaymentCredential,
StakeAddressReference,
PaymentKey,
PaymentExtendedKey,
-- * Stake addresses
-- | Constructing and inspecting stake addresses
StakeAddress,
StakeCredential,
makeStakeAddress,
StakeKey,
StakeExtendedKey,
-- * Building transactions
-- | Constructing and inspecting transactions
TxBody,
TxId,
getTxId,
TxIn(TxIn),
TxOut(TxOut),
TxIx(TxIx),
TTL,
TxFee,
Lovelace(Lovelace),
makeByronTransaction,
makeShelleyTransaction,
SlotNo,
TxExtraContent,
txExtraContentEmpty,
Certificate,
-- * Signing transactions
-- | Creating transaction witnesses one by one, or all in one go.
Tx,
getTxBody,
getTxWitnesses,
-- ** Signing in one go
signByronTransaction,
signShelleyTransaction,
-- ** Incremental signing and separate witnesses
makeSignedTransaction,
Witness,
makeByronKeyWitness,
ShelleyWitnessSigningKey,
makeShelleyKeyWitness,
makeShelleyBootstrapWitness,
makeShelleyScriptWitness,
-- * Fee calculation
transactionFee,
estimateTransactionFee,
-- * Transaction metadata
-- | Embedding additional structured data within transactions.
TxMetadata(TxMetadata),
TxMetadataValue,
makeTransactionMetadata,
-- * Registering stake address and delegating
-- | Certificates that are embedded in transactions for registering and
-- unregistering stake address, and for setting the stake pool delegation
-- choice for a stake address.
makeStakeAddressRegistrationCertificate,
makeStakeAddressDeregistrationCertificate,
makeStakeAddressDelegationCertificate,
-- * Registering stake pools
-- | Certificates that are embedded in transactions for registering and
-- retiring stake pools. This includes updating the stake pool parameters.
makeStakePoolRegistrationCertificate,
makeStakePoolRetirementCertificate,
StakePoolParameters,
StakePoolRelay,
StakePoolMetadataReference,
-- ** Stake pool off-chain metadata
StakePoolMetadata,
validateAndHashStakePoolMetadata,
StakePoolMetadataValidationError,
-- * Scripts
-- | Both 'PaymentCredential's and 'StakeCredential's can use scripts.
-- Shelley supports multi-signatures via scripts.
Script,
-- ** Script addresses
-- | Making addresses from scripts.
scriptHashShelley,
-- ** Multi-signature scripts
-- | Making multi-signature scripts.
MultiSigScript,
makeMultiSigScriptShelley,
-- * Serialisation
-- | Support for serialising data in JSON, CBOR and text files.
-- ** CBOR
SerialiseAsCBOR,
ToCBOR,
FromCBOR,
serialiseToCBOR,
deserialiseFromCBOR,
-- ** JSON
ToJSON,
FromJSON,
serialiseToJSON,
deserialiseFromJSON,
-- ** Bech32
SerialiseAsBech32,
serialiseToBech32,
deserialiseFromBech32,
deserialiseAnyOfFromBech32,
Bech32DecodeError,
-- ** Addresses
-- | Address serialisation is (sadly) special
SerialiseAddress,
serialiseAddress,
deserialiseAddress,
-- ** Raw binary
-- | Some types have a natural raw binary format.
SerialiseAsRawBytes,
serialiseToRawBytes,
deserialiseFromRawBytes,
serialiseToRawBytesHex,
deserialiseFromRawBytesHex,
-- ** Text envelope
-- | Support for a envelope file format with text headers and a hex-encoded
-- binary payload.
HasTextEnvelope,
TextEnvelope,
TextEnvelopeType,
TextEnvelopeDescr,
TextEnvelopeError,
serialiseToTextEnvelope,
deserialiseFromTextEnvelope,
readFileTextEnvelope,
writeFileTextEnvelope,
readTextEnvelopeFromFile,
readTextEnvelopeOfTypeFromFile,
-- *** Reading one of several key types
FromSomeType,
deserialiseFromTextEnvelopeAnyOf,
readFileTextEnvelopeAnyOf,
-- * Errors
Error,
throwErrorAsException,
FileError,
-- * Node interaction
-- | Operations that involve talking to a local Cardano node.
-- ** Queries
-- ** Submitting transactions
-- ** Low level protocol interaction with a Cardano node
connectToLocalNode,
LocalNodeConnectInfo,
localNodeSocketPath,
localNodeNetworkId,
localNodeConsensusMode,
NodeConsensusMode,
LocalNodeClientProtocols,
localChainSyncClient,
localTxSubmissionClient,
localStateQueryClient,
nullLocalNodeClientProtocols,
-- connectToRemoteNode,
-- *** Chain sync protocol
ChainSyncClient,
runChainSyncClient,
-- *** Local tx submission
LocalTxSubmissionClient,
runLocalTxSubmissionClient,
submitTxToNodeLocal,
-- *** Local state query
LocalStateQueryClient,
runLocalStateQueryClient,
queryNodeLocalState,
-- * Node operation
-- | Support for the steps needed to operate a node
-- ** Operational certificates
OperationalCertificate,
OperationalCertificateIssueCounter,
OperationalCertIssueError,
issueOperationalCertificate,
-- * Genesis file
-- | Types and functions needed to inspect or create a genesis file.
GenesisKey,
GenesisExtendedKey,
GenesisDelegateKey,
GenesisDelegateExtendedKey,
GenesisUTxOKey,
genesisUTxOPseudoTxIn,
-- * Special transactions
-- | There are various additional things that can be embedded in a
-- transaction for special operations.
makeMIRCertificate,
makeGenesisKeyDelegationCertificate,
NetworkMagic,
makeShelleyUpdateProposal,
) where
import Cardano.Api.Typed