-
Notifications
You must be signed in to change notification settings - Fork 721
/
Api.hs
711 lines (617 loc) · 17.6 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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
-- | 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 (
-- * Eras
ByronEra,
ShelleyEra,
AllegraEra,
MaryEra,
AlonzoEra,
BabbageEra,
CardanoEra(..),
IsCardanoEra(..),
AnyCardanoEra(..),
anyCardanoEra,
InAnyCardanoEra(..),
-- ** Shelley-based eras
ShelleyBasedEra(..),
IsShelleyBasedEra(..),
InAnyShelleyBasedEra(..),
CardanoEraStyle(..),
cardanoEraStyle,
shelleyBasedToCardanoEra,
-- ** Deprecated
Byron,
Shelley,
Allegra,
Mary,
-- * Type tags
HasTypeProxy(..),
AsType(..),
-- * Cryptographic key interface
-- $keys
Key(..),
SigningKey(..),
VerificationKey(..),
castVerificationKey,
castSigningKey,
generateSigningKey,
-- ** 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,
ByronAddr,
ShelleyAddr,
NetworkId(..),
-- ** Byron addresses
makeByronAddress,
ByronKey,
ByronKeyLegacy,
-- ** Shelley addresses
makeShelleyAddress,
PaymentCredential(..),
StakeAddressPointer(..),
StakeAddressReference(..),
PaymentKey,
PaymentExtendedKey,
-- ** Addresses in any era
AddressAny(..),
lexPlausibleAddressString,
parseAddressAny,
-- ** Addresses in specific eras
AddressInEra(..),
isKeyAddress,
AddressTypeInEra(..),
byronAddressInEra,
shelleyAddressInEra,
anyAddressInShelleyBasedEra,
anyAddressInEra,
toAddressAny,
makeByronAddressInEra,
makeShelleyAddressInEra,
-- * Stake addresses
-- | Constructing and inspecting stake addresses
StakeAddress,
StakeCredential,
makeStakeAddress,
StakeKey,
StakeExtendedKey,
-- * Currency values
-- ** Ada \/ Lovelace
Lovelace(..),
-- ** Multi-asset values
Quantity(..),
PolicyId(..),
scriptPolicyId,
AssetName(..),
AssetId(..),
Value,
parseValue,
policyId,
selectAsset,
valueFromList,
valueToList,
filterValue,
negateValue,
ValueNestedRep(..),
ValueNestedBundle(..),
valueToNestedRep,
valueFromNestedRep,
renderValue,
renderValuePretty,
-- ** Ada \/ Lovelace within multi-asset values
quantityToLovelace,
lovelaceToQuantity,
selectLovelace,
lovelaceToValue,
valueToLovelace,
-- * Blocks
-- ** Blocks in the context of an era
Block(Block),
BlockHeader(..),
getBlockHeader,
-- ** Points on the chain
ChainPoint(..),
EpochNo(..),
-- ** Tip of the chain
ChainTip(..),
BlockNo(..),
chainTipToChainPoint,
-- * Building transactions
-- * Building transactions
-- | Constructing and inspecting transactions
-- ** Transaction bodies
TxBody(TxBody),
makeTransactionBody,
TxBodyContent(..),
TxBodyError(..),
TxBodyScriptData(..),
-- ** Transaction Ids
TxId(..),
getTxId,
-- ** Transaction inputs
TxIn(TxIn),
TxIx(TxIx),
renderTxIn,
-- ** Transaction outputs
CtxTx, CtxUTxO,
TxOut(TxOut),
TxOutValue(..),
txOutValueToLovelace,
txOutValueToValue,
lovelaceToTxOutValue,
TxOutDatum(..),
parseHash,
-- ** Other transaction body types
TxInsCollateral(..),
TxInsReference(..),
TxTotalCollateral(..),
TxReturnCollateral(..),
TxFee(..),
TxValidityLowerBound(..),
TxValidityUpperBound(..),
SlotNo(..),
EpochSlots(..),
TxMetadataInEra(..),
TxAuxScripts(..),
TxExtraKeyWitnesses(..),
TxWithdrawals(..),
TxCertificates(..),
TxUpdateProposal(..),
TxMintValue(..),
-- ** Building vs viewing transactions
BuildTxWith(..),
BuildTx,
ViewTx,
-- ** Era-dependent transaction body features
CollateralSupportedInEra(..),
MultiAssetSupportedInEra(..),
OnlyAdaSupportedInEra(..),
TxFeesExplicitInEra(..),
TxFeesImplicitInEra(..),
ValidityUpperBoundSupportedInEra(..),
ValidityNoUpperBoundSupportedInEra(..),
ValidityLowerBoundSupportedInEra(..),
TxMetadataSupportedInEra(..),
AuxScriptsSupportedInEra(..),
TxExtraKeyWitnessesSupportedInEra(..),
ScriptDataSupportedInEra(..),
WithdrawalsSupportedInEra(..),
CertificatesSupportedInEra(..),
UpdateProposalSupportedInEra(..),
-- ** Feature availability functions
collateralSupportedInEra,
multiAssetSupportedInEra,
txFeesExplicitInEra,
validityUpperBoundSupportedInEra,
validityNoUpperBoundSupportedInEra,
validityLowerBoundSupportedInEra,
txMetadataSupportedInEra,
auxScriptsSupportedInEra,
extraKeyWitnessesSupportedInEra,
withdrawalsSupportedInEra,
certificatesSupportedInEra,
updateProposalSupportedInEra,
scriptDataSupportedInEra,
totalAndReturnCollateralSupportedInEra,
-- ** Fee calculation
transactionFee,
toLedgerEpochInfo,
estimateTransactionFee,
evaluateTransactionFee,
estimateTransactionKeyWitnessCount,
-- ** Minimum required UTxO calculation
calculateMinimumUTxO,
MinimumUTxOError,
-- ** Script execution units
evaluateTransactionExecutionUnits,
ScriptExecutionError(..),
TransactionValidityError(..),
-- ** Transaction balance
evaluateTransactionBalance,
-- ** Building transactions with automated fees and balancing
makeTransactionBodyAutoBalance,
BalancedTxBody(..),
TxBodyErrorAutoBalance(..),
TxScriptValidity(..),
ScriptValidity(..),
TxScriptValiditySupportedInEra(..),
scriptValidityToTxScriptValidity,
txScriptValiditySupportedInShelleyBasedEra,
txScriptValiditySupportedInCardanoEra,
-- * Signing transactions
-- | Creating transaction witnesses one by one, or all in one go.
Tx(Tx),
getTxBody,
getTxWitnesses,
-- ** Signing in one go
signByronTransaction,
signShelleyTransaction,
-- ** Incremental signing and separate witnesses
makeSignedTransaction,
KeyWitness,
makeByronKeyWitness,
ShelleyWitnessSigningKey(..),
makeShelleyKeyWitness,
makeShelleyBootstrapWitness,
-- * Transaction metadata
-- | Embedding additional structured data within transactions.
TxMetadata(..),
-- ** Constructing metadata
TxMetadataValue(..),
makeTransactionMetadata,
-- ** Validating metadata
validateTxMetadata,
TxMetadataRangeError (..),
-- ** Conversion to\/from JSON
TxMetadataJsonSchema (..),
metadataFromJson,
metadataToJson,
metadataValueToJsonNoSchema,
TxMetadataJsonError (..),
TxMetadataJsonSchemaError (..),
-- * Certificates
Certificate(..),
-- ** 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.
-- ** Script languages
SimpleScriptV1,
SimpleScriptV2,
PlutusScriptV1,
PlutusScriptV2,
ScriptLanguage(..),
SimpleScriptVersion(..),
PlutusScriptVersion(..),
AnyScriptLanguage(..),
AnyPlutusScriptVersion(..),
IsScriptLanguage(..),
IsSimpleScriptLanguage(..),
-- ** Scripts in a specific language
Script(..),
-- ** Scripts in any language
ScriptInAnyLang(..),
toScriptInAnyLang,
-- ** Scripts in a specific era
ScriptInEra(..),
toScriptInEra,
eraOfScriptInEra,
-- ** Use of a script in an era as a witness
WitCtxTxIn, WitCtxMint, WitCtxStake,
WitCtx(..),
ScriptWitness(..),
Witness(..),
KeyWitnessInCtx(..),
ScriptWitnessInCtx(..),
ScriptDatum(..),
ScriptRedeemer,
scriptWitnessScript,
-- ** Inspecting 'ScriptWitness'es
AnyScriptWitness(..),
ScriptWitnessIndex(..),
renderScriptWitnessIndex,
collectTxBodyScriptWitnesses,
mapTxScriptWitnesses,
-- ** Languages supported in each era
ScriptLanguageInEra(..),
scriptLanguageSupportedInEra,
languageOfScriptLanguageInEra,
eraOfScriptLanguageInEra,
-- ** Simple scripts
-- | Making multi-signature and time-lock scripts.
SimpleScript(..),
TimeLocksSupported(..),
timeLocksSupported,
adjustSimpleScriptVersion,
-- ** Plutus scripts
PlutusScript,
examplePlutusScriptAlwaysSucceeds,
examplePlutusScriptAlwaysFails,
-- ** Script data
ScriptData(..),
hashScriptData,
-- ** Validation
ScriptDataRangeError (..),
validateScriptData,
-- ** Conversion to\/from JSON
ScriptDataJsonSchema (..),
scriptDataFromJson,
scriptDataToJson,
ScriptDataJsonError (..),
ScriptDataJsonSchemaError (..),
-- ** Script execution units
ExecutionUnits(..),
ExecutionUnitPrices(..),
CostModel(..),
validateCostModel,
-- ** Script addresses
-- | Making addresses from scripts.
ScriptHash,
hashScript,
-- * Serialisation
-- | Support for serialising data in JSON, CBOR and text files.
-- ** CBOR
SerialiseAsCBOR,
ToCBOR,
FromCBOR,
serialiseToCBOR,
deserialiseFromCBOR,
-- ** JSON
ToJSON,
FromJSON,
serialiseToJSON,
deserialiseFromJSON,
JsonDecodeError(..),
readFileJSON,
writeFileJSON,
prettyPrintJSON,
-- ** 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,
serialiseToRawBytesHexText,
-- ** Text envelope
-- | Support for a envelope file format with text headers and a hex-encoded
-- binary payload.
HasTextEnvelope(..),
TextEnvelope(..),
TextEnvelopeType(..),
TextEnvelopeDescr,
TextEnvelopeError(..),
textEnvelopeRawCBOR,
serialiseToTextEnvelope,
deserialiseFromTextEnvelope,
readFileTextEnvelope,
writeFileTextEnvelope,
writeFileTextEnvelopeWithOwnerPermissions,
readTextEnvelopeFromFile,
readTextEnvelopeOfTypeFromFile,
-- ** Text envelope CDDL
-- | Support for serialising values in the ledger's CDDL format.
-- Note, this will be deprecated in the future in favour of a
-- single API.
FromSomeTypeCDDL(..),
readFileTextEnvelopeCddlAnyOf,
writeTxFileTextEnvelopeCddl,
writeTxWitnessFileTextEnvelopeCddl,
serialiseTxLedgerCddl,
deserialiseTxLedgerCddl,
serialiseWitnessLedgerCddl,
deserialiseWitnessLedgerCddl,
TextEnvelopeCddlError(..),
-- *** 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
-- ** High level protocol interaction with a Cardano node
-- *** Initialization / Accumulation
Env(..),
envSecurityParam,
LedgerState(..),
initialLedgerState,
applyBlock,
ValidationMode(..),
-- *** Ledger Events
LedgerEvent(..),
MIRDistributionDetails(..),
PoolReapDetails(..),
toLedgerEvent,
-- *** Traversing the block chain
foldBlocks,
chainSyncClientWithLedgerState,
chainSyncClientPipelinedWithLedgerState,
-- *** Errors
LedgerStateError(..),
FoldBlocksError(..),
GenesisConfigError(..),
InitialLedgerStateError(..),
renderLedgerStateError,
renderFoldBlocksError,
renderGenesisConfigError,
renderInitialLedgerStateError,
-- ** Low level protocol interaction with a Cardano node
connectToLocalNode,
connectToLocalNodeWithVersion,
LocalNodeConnectInfo(..),
AnyConsensusMode(..),
renderMode,
ConsensusMode(CardanoMode),
consensusModeOnly,
ConsensusModeIsMultiEra(..),
AnyConsensusModeParams(..),
ConsensusModeParams(..),
ConsensusProtocol,
ChainDepStateProtocol,
ConsensusBlockForMode,
ConsensusBlockForEra,
EraInMode(..),
toEraInMode,
LocalNodeClientProtocols(..),
LocalNodeClientParams(..),
mkLocalNodeClientParams,
LocalChainSyncClient(..),
CardanoMode,
-- connectToRemoteNode,
-- *** Chain sync protocol
-- | To construct a @ChainSyncClient@ see @Cardano.Api.Client@ or
-- @Cardano.Api.ClientPipelined@.
ChainSyncClient(..),
ChainSyncClientPipelined(..),
BlockInMode(..),
LocalNodeClientProtocolsInMode,
-- *** Local tx submission
LocalTxSubmissionClient,
TxInMode(..),
TxValidationErrorInMode(..),
runLocalTxSubmissionClient,
submitTxToNodeLocal,
-- *** Local state query
LocalStateQueryClient(..),
QueryInMode(..),
SystemStart(..),
QueryInEra(..),
QueryInShelleyBasedEra(..),
QueryUTxOFilter(..),
UTxO(..),
queryNodeLocalState,
-- *** Local tx monitoring
LocalTxMonitorClient(..),
LocalTxMonitoringQuery(..),
LocalTxMonitoringResult(..),
MempoolSizeAndCapacity(..),
queryTxMonitoringLocal,
EraHistory(..),
getProgress,
-- *** Common queries
getLocalChainTip,
-- * Node operation
-- | Support for the steps needed to operate a node
-- ** Operational certificates
OperationalCertificate,
OperationalCertificateIssueCounter,
OperationalCertIssueError,
getHotKey,
getKesPeriod,
getOpCertCount,
issueOperationalCertificate,
-- * Genesis file
-- | Types and functions needed to inspect or create a genesis file.
GenesisKey,
GenesisExtendedKey,
GenesisDelegateKey,
GenesisDelegateExtendedKey,
GenesisUTxOKey,
genesisUTxOPseudoTxIn,
-- ** Genesis parameters
GenesisParameters(..),
-- * Special transactions
-- | There are various additional things that can be embedded in a
-- transaction for special operations.
makeMIRCertificate,
makeGenesisKeyDelegationCertificate,
MIRTarget (..),
-- * Protocol parameter updates
UpdateProposal(..),
ProtocolParametersUpdate(..),
makeShelleyUpdateProposal,
PraosNonce,
makePraosNonce,
NetworkMagic(..),
-- ** Conversions
toLedgerPParams,
fromLedgerPParams,
toCtxUTxOTxOut,
--TODO: arrange not to export these
fromNetworkMagic,
toNetworkMagic,
fromLedgerTxOuts,
toLedgerUTxO,
runParsecParser,
SlotsInEpoch(..),
SlotsToEpochEnd(..),
slotToEpoch,
NodeToClientVersion(..),
-- ** Monadic queries
LocalStateQueryExpr,
executeLocalStateQueryExpr,
queryExpr,
determineEraExpr,
chainPointToSlotNo,
chainPointToHeaderHash,
makeChainTip,
parseFilePath,
writeSecrets,
-- ** Cast functions
EraCast (..),
EraCastError (..),
) where
import Cardano.Api.Address
import Cardano.Api.Block
import Cardano.Api.Certificate
import Cardano.Api.EraCast
import Cardano.Api.Eras
import Cardano.Api.Error
import Cardano.Api.Fees
import Cardano.Api.GenesisParameters
import Cardano.Api.Hash
import Cardano.Api.HasTypeProxy
import Cardano.Api.IPC
import Cardano.Api.IPC.Monad
import Cardano.Api.Key
import Cardano.Api.KeysByron
import Cardano.Api.KeysShelley
import Cardano.Api.LedgerEvent
import Cardano.Api.LedgerState
import Cardano.Api.Modes
import Cardano.Api.NetworkId
import Cardano.Api.OperationalCertificate
import Cardano.Api.ProtocolParameters
import Cardano.Api.Query hiding (LedgerState (..))
import Cardano.Api.Script
import Cardano.Api.ScriptData
import Cardano.Api.SerialiseBech32
import Cardano.Api.SerialiseCBOR
import Cardano.Api.SerialiseJSON
import Cardano.Api.SerialiseLedgerCddl
import Cardano.Api.SerialiseRaw
import Cardano.Api.SerialiseTextEnvelope
import Cardano.Api.StakePoolMetadata
import Cardano.Api.Tx
import Cardano.Api.TxBody
import Cardano.Api.TxMetadata
import Cardano.Api.Utils
import Cardano.Api.Value
import Cardano.Api.ValueParser