/
Link.hs
986 lines (880 loc) · 25 KB
/
Link.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
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE UndecidableInstances #-}
-- |
-- Copyright: © 2018-2020 IOHK
-- License: Apache-2.0
--
-- Type-safe endpoint accessors for the wallet API. Under normal circumstances,
-- one would prefer to use 'WalletClient' from 'Cardano.Wallet.Api.Client' and
-- not to bother with endpoints at all.
--
-- Yet, in some cases (like in black-box testing), one could want to purposely
-- send malformed requests to specific endpoints. Thus, this module facilitates
-- the construction of valid endpoints that'd be accepted by the server, and for
-- which, users are free to send all sort of data as payload, valid or invalid.
--
-- This module is meant to be used via qualified imports and with
-- type-applications since all exposed functions are type ambiguous in a
-- variable @style@ of type 'WalletStyle'.
--
-- @import qualified Cardano.Wallet.Api.Link as Link@
--
-- For examples:
--
-- >>> Link.deleteWallet @'Shelley myWallet
-- ( "DELETE", "/v2/wallets/2512a00e9653fe49a44a5886202e24d77eeb998f" )
--
-- >>> Link.getWallet @('Byron 'Icarus) myWallet
-- ( "GET", "/v2/byron-wallets/2512a00e9653fe49a44a5886202e24d77eeb998f" )
module Cardano.Wallet.Api.Link
( -- * Wallets
deleteWallet
, getWallet
, listWallets
, postWallet
, putWallet
, putWalletPassphrase
, getWalletUtxoSnapshot
, getUTxOsStatistics
, createMigrationPlan
, migrateWallet
-- * WalletKeys
, getWalletKey
, signMetadata
, postAccountKey
, getAccountKey
, getPolicyKey
, postPolicyKey
, postPolicyId
-- * Addresses
, postRandomAddress
, putRandomAddresses
, listAddresses
, listAddresses'
, inspectAddress
, postAnyAddress
-- * CoinSelections
, selectCoins
-- * Assets
, listAssets
, getAsset
, listByronAssets
, getByronAsset
-- * Transactions
, createTransactionOld
, listTransactions
, listTransactions'
, getTransactionFeeOld
, deleteTransaction
, getTransaction
, createUnsignedTransaction
, signTransaction
, balanceTransaction
, decodeTransaction
, submitTransaction
-- * StakePools
, listStakePools
, listStakeKeys
, joinStakePool
, quitStakePool
, getDelegationFee
, postPoolMaintenance
, getPoolMaintenance
-- * Network
, getNetworkInfo
, getNetworkParams
, getNetworkClock
, getNetworkClock'
, getBlocksLatestHeader
-- * Proxy
, postExternalTransaction
-- * Settings
, putSettings
, getSettings
-- * Utils
, getCurrentSMASHHealth
-- * Shared Wallets
, patchSharedWallet
, PostWallet
, Discriminate
) where
import Prelude
import Cardano.Wallet.Api.Types
( ApiAddressInspectData (..)
, ApiPoolSpecifier
, ApiT (..)
, ApiTxId (ApiTxId)
, Iso8601Time
, KeyFormat
, MinWithdrawal (..)
, WalletStyle (..)
)
import Cardano.Wallet.Api.Types.SchemaMetadata
( TxMetadataSchema (..), toSimpleMetadataFlag )
import Cardano.Wallet.Primitive.AddressDerivation
( DerivationIndex, NetworkDiscriminant (..), Role )
import Cardano.Wallet.Primitive.AddressDiscovery.Shared
( CredentialType (..) )
import Cardano.Wallet.Primitive.Types
( SmashServer, SortOrder, WalletId (..) )
import Cardano.Wallet.Primitive.Types.Address
( AddressState )
import Cardano.Wallet.Primitive.Types.Coin
( Coin (..) )
import Cardano.Wallet.Primitive.Types.Hash
( Hash )
import Cardano.Wallet.Primitive.Types.TokenPolicy
( TokenName, TokenPolicyId, nullTokenName )
import Data.Function
( (&) )
import Data.Generics.Internal.VL.Lens
( (^.) )
import Data.Generics.Product.Typed
( HasType, typed )
import Data.Proxy
( Proxy (..) )
import Data.Text
( Text )
import GHC.Stack
( HasCallStack )
import GHC.TypeLits
( Symbol )
import Network.HTTP.Types.Method
( Method )
import Numeric.Natural
( Natural )
import Servant.API
( (:>)
, Capture'
, Header'
, IsElem
, NoContentVerb
, QueryFlag
, QueryParam
, ReflectMethod (..)
, ReqBody
, Verb
)
import Servant.Links
( HasLink (..), safeLink' )
import Web.HttpApiData
( ToHttpApiData (..) )
import qualified Cardano.Wallet.Api as Api
--
-- Wallets
--
-- NOTE
-- Type-class is necessary here to type-check 'IsElem endpoint Api' below.
class PostWallet (style :: WalletStyle) where
postWallet :: (Method, Text)
instance PostWallet 'Shelley where
postWallet = endpoint @Api.PostWallet id
instance PostWallet 'Byron where
postWallet = endpoint @Api.PostByronWallet id
instance PostWallet 'Shared where
postWallet = endpoint @Api.PostSharedWallet id
deleteWallet
:: forall (style :: WalletStyle) w.
( Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
deleteWallet w = discriminate @style
(endpoint @Api.DeleteWallet (wid &))
(endpoint @Api.DeleteByronWallet (wid &))
(endpoint @Api.DeleteSharedWallet (wid &))
where
wid = w ^. typed @(ApiT WalletId)
getWallet
:: forall (style :: WalletStyle) w.
( Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
getWallet w = discriminate @style
(endpoint @Api.GetWallet (wid &))
(endpoint @Api.GetByronWallet (wid &))
(endpoint @Api.GetSharedWallet (wid &))
where
wid = w ^. typed @(ApiT WalletId)
getUTxOsStatistics
:: forall (style :: WalletStyle) w.
( Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
getUTxOsStatistics w = discriminate @style
(endpoint @Api.GetUTxOsStatistics (wid &))
(endpoint @Api.GetByronUTxOsStatistics (wid &))
(endpoint @Api.GetUTxOsStatisticsShared (wid &))
where
wid = w ^. typed @(ApiT WalletId)
getWalletUtxoSnapshot
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
getWalletUtxoSnapshot w = discriminate @style
(endpoint @Api.GetWalletUtxoSnapshot (wid &))
(endpoint @Api.GetByronWalletUtxoSnapshot (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
listWallets
:: forall (style :: WalletStyle).
( Discriminate style
)
=> (Method, Text)
listWallets = discriminate @style
(endpoint @Api.ListWallets id)
(endpoint @Api.ListByronWallets id)
(endpoint @Api.ListSharedWallets id)
putWallet
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
putWallet w = discriminate @style
(endpoint @Api.PutWallet (wid &))
(endpoint @Api.PutByronWallet (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
putWalletPassphrase
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
putWalletPassphrase w = discriminate @style
(endpoint @Api.PutWalletPassphrase (wid &))
(endpoint @Api.PutByronWalletPassphrase (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
migrateWallet
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
migrateWallet w = discriminate @style
(endpoint @(Api.MigrateShelleyWallet Net) (wid &))
(endpoint @(Api.MigrateByronWallet Net) (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
createMigrationPlan
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
createMigrationPlan w = discriminate @style
(endpoint @(Api.CreateShelleyWalletMigrationPlan Net) (wid &))
(endpoint @(Api.CreateByronWalletMigrationPlan Net) (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
--
-- WalletKeys
--
getWalletKey
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> Role
-> DerivationIndex
-> Maybe Bool
-> (Method, Text)
getWalletKey w role_ index hashed = discriminate @style
(endpoint @Api.GetWalletKey (\mk -> mk wid (ApiT role_) (ApiT index) hashed))
(notSupported "Byron")
(endpoint @Api.GetSharedWalletKey (\mk -> mk wid (ApiT role_) (ApiT index) hashed))
where
wid = w ^. typed @(ApiT WalletId)
signMetadata
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> Role
-> DerivationIndex
-> (Method, Text)
signMetadata w role_ index =
endpoint @Api.SignMetadata (\mk -> mk wid (ApiT role_) (ApiT index))
where
wid = w ^. typed @(ApiT WalletId)
postAccountKey
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> DerivationIndex
-> (Method, Text)
postAccountKey w index = discriminate @style
(endpoint @Api.PostAccountKey (\mk -> mk wid (ApiT index)))
(notSupported "Byron")
(endpoint @Api.PostAccountKeyShared (\mk -> mk wid (ApiT index)))
where
wid = w ^. typed @(ApiT WalletId)
getAccountKey
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> Maybe KeyFormat
-> (Method, Text)
getAccountKey w extended = discriminate @style
(endpoint @Api.GetAccountKey (\mk -> mk wid extended))
(notSupported "Byron")
(endpoint @Api.GetAccountKeyShared (\mk -> mk wid extended))
where
wid = w ^. typed @(ApiT WalletId)
getPolicyKey
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> Maybe Bool
-> (Method, Text)
getPolicyKey w hashed = discriminate @style
(endpoint @Api.GetPolicyKey (\mk -> mk wid hashed))
(notSupported "Byron")
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
postPolicyKey
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> Maybe Bool
-> (Method, Text)
postPolicyKey w hashed = discriminate @style
(endpoint @Api.PostPolicyKey (\mk -> mk wid hashed))
(notSupported "Byron")
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
postPolicyId
:: forall (style :: WalletStyle) w.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
postPolicyId w = discriminate @style
(endpoint @Api.PostPolicyId (wid &))
(notSupported "Byron")
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
--
-- Addresses
--
postRandomAddress
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
postRandomAddress w =
endpoint @(Api.PostByronAddress Net) (wid &)
where
wid = w ^. typed @(ApiT WalletId)
putRandomAddresses
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
putRandomAddresses w =
endpoint @(Api.PutByronAddresses Net) (wid &)
where
wid = w ^. typed @(ApiT WalletId)
listAddresses
:: forall style w.
( HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
listAddresses w =
listAddresses' @style w Nothing
listAddresses'
:: forall style w.
( HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> Maybe AddressState
-> (Method, Text)
listAddresses' w mstate = discriminate @style
(endpoint @(Api.ListAddresses Net) (\mk -> mk wid (ApiT <$> mstate)))
(endpoint @(Api.ListByronAddresses Net) (\mk -> mk wid (ApiT <$> mstate)))
(endpoint @(Api.ListSharedAddresses Net) (\mk -> mk wid (ApiT <$> mstate)))
where
wid = w ^. typed @(ApiT WalletId)
inspectAddress
:: ApiAddressInspectData
-> (Method, Text)
inspectAddress addr =
endpoint @Api.InspectAddress (addr &)
postAnyAddress
:: (Method, Text)
postAnyAddress =
endpoint @(Api.PostAnyAddress Net) id
--
-- Coin Selections
--
selectCoins
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
selectCoins w = discriminate @style
(endpoint @(Api.SelectCoins Net) (wid &))
(endpoint @(Api.ByronSelectCoins Net) (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
--
-- Assets
--
listAssets
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
listAssets w =
endpoint @Api.ListAssets (wid &)
where
wid = w ^. typed @(ApiT WalletId)
getAsset
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> TokenPolicyId
-> TokenName
-> (Method, Text)
getAsset w pid n
| n == nullTokenName = endpoint @Api.GetAssetDefault mkURLDefault
| otherwise = endpoint @Api.GetAsset mkURL
where
wid = w ^. typed @(ApiT WalletId)
mkURL mk = mk wid (ApiT pid) (ApiT n)
mkURLDefault mk = mk wid (ApiT pid)
listByronAssets
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
listByronAssets w =
endpoint @Api.ListByronAssets (wid &)
where
wid = w ^. typed @(ApiT WalletId)
getByronAsset
:: forall w.
( HasType (ApiT WalletId) w
)
=> w
-> TokenPolicyId
-> TokenName
-> (Method, Text)
getByronAsset w pid n
| n == nullTokenName = endpoint @Api.GetByronAssetDefault mkURLDefault
| otherwise = endpoint @Api.GetByronAsset mkURL
where
wid = w ^. typed @(ApiT WalletId)
mkURL mk = mk wid (ApiT pid) (ApiT n)
mkURLDefault mk = mk wid (ApiT pid)
--
-- Transactions
--
createTransactionOld
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
createTransactionOld w = discriminate @style
(endpoint @(Api.CreateTransactionOld Net) (wid &))
(endpoint @(Api.CreateByronTransactionOld Net) (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
listTransactions
:: forall (style :: WalletStyle) w.
( Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> (Method, Text)
listTransactions w =
listTransactions' @style w Nothing Nothing Nothing Nothing
listTransactions'
:: forall (style :: WalletStyle) w.
( Discriminate style
, HasType (ApiT WalletId) w
)
=> w
-> Maybe Natural
-> Maybe Iso8601Time
-> Maybe Iso8601Time
-> Maybe SortOrder
-> (Method, Text)
listTransactions' w minWithdrawal inf sup order = discriminate @style
(endpoint @(Api.ListTransactions Net)
(\mk -> mk
wid
(MinWithdrawal <$> minWithdrawal)
inf
sup
(ApiT <$> order)
(toSimpleMetadataFlag TxMetadataDetailedSchema)
)
)
(endpoint @(Api.ListByronTransactions Net)
(\mk -> mk wid inf sup (ApiT <$> order)))
(endpoint @(Api.ListSharedTransactions Net)
(\mk -> mk
wid
(MinWithdrawal <$> minWithdrawal)
inf
sup
(ApiT <$> order)
(toSimpleMetadataFlag TxMetadataDetailedSchema)
)
)
where
wid = w ^. typed @(ApiT WalletId)
getTransactionFeeOld
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
getTransactionFeeOld w = discriminate @style
(endpoint @(Api.PostTransactionFeeOld Net) (wid &))
(endpoint @(Api.PostByronTransactionFeeOld Net) (wid &))
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
deleteTransaction
:: forall (style :: WalletStyle) w t.
( HasCallStack
, Discriminate style
, HasType (ApiT WalletId) w
, HasType (ApiT (Hash "Tx")) t
)
=> w
-> t
-> (Method, Text)
deleteTransaction w t = discriminate @style
(endpoint @Api.DeleteTransaction mkURL)
(endpoint @Api.DeleteByronTransaction mkURL)
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
tid = ApiTxId (t ^. typed @(ApiT (Hash "Tx")))
mkURL mk = mk wid tid
getTransaction
:: forall (style :: WalletStyle) w t.
( Discriminate style
, HasType (ApiT WalletId) w
, HasType (ApiT (Hash "Tx")) t
)
=> w
-> t
-> (Method, Text)
getTransaction w t = discriminate @style
(endpoint @(Api.GetTransaction Net) mkShelleyURL)
(endpoint @(Api.GetByronTransaction Net) mkByronURL)
(endpoint @(Api.GetSharedTransaction Net) mkShelleyURL)
where
wid = w ^. typed @(ApiT WalletId)
tid = ApiTxId (t ^. typed @(ApiT (Hash "Tx")))
mkByronURL mk = mk wid tid
mkShelleyURL :: (ApiT WalletId -> ApiTxId -> Bool -> Text) -> Text
mkShelleyURL mk =
mk wid tid (toSimpleMetadataFlag TxMetadataDetailedSchema)
createUnsignedTransaction
:: forall style w.
( HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
createUnsignedTransaction w = discriminate @style
(endpoint @(Api.ConstructTransaction Net) (wid &))
(notSupported "Byron")
(endpoint @(Api.ConstructSharedTransaction Net) (wid &))
where
wid = w ^. typed @(ApiT WalletId)
signTransaction
:: forall style w.
( HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
signTransaction w = discriminate @style
(endpoint @(Api.SignTransaction Net) (wid &))
(notSupported "Byron")
(endpoint @(Api.SignSharedTransaction Net) (wid &))
where
wid = w ^. typed @(ApiT WalletId)
balanceTransaction
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
balanceTransaction w = discriminate @style
(endpoint @(Api.BalanceTransaction Net) (wid &))
(notSupported "Byron")
(notSupported "Shared")
where
wid = w ^. typed @(ApiT WalletId)
decodeTransaction
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
decodeTransaction w = discriminate @style
(endpoint @(Api.DecodeTransaction Net) (wid &))
(notSupported "Byron")
(endpoint @(Api.DecodeSharedTransaction Net) (wid &))
where
wid = w ^. typed @(ApiT WalletId)
submitTransaction
:: forall style w.
( HasCallStack
, HasType (ApiT WalletId) w
, Discriminate style
)
=> w
-> (Method, Text)
submitTransaction w = discriminate @style
(endpoint @Api.SubmitTransaction (wid &))
(notSupported "Byron")
(endpoint @Api.SubmitSharedTransaction (wid &))
where
wid = w ^. typed @(ApiT WalletId)
--
-- Stake Pools
--
postPoolMaintenance :: (Method, Text)
postPoolMaintenance = endpoint @Api.PostPoolMaintenance id
getPoolMaintenance :: (Method, Text)
getPoolMaintenance = endpoint @Api.GetPoolMaintenance id
listStakePools :: Maybe Coin -> (Method, Text)
listStakePools stake = endpoint @Api.ListStakePools ($ ApiT <$> stake)
listStakeKeys :: forall w. HasType (ApiT WalletId) w => w -> (Method, Text)
listStakeKeys w = endpoint @(Api.ListStakeKeys ()) ($ w^.typed @(ApiT WalletId))
joinStakePool
:: forall s w.
( HasType ApiPoolSpecifier s
, HasType (ApiT WalletId) w
)
=> s
-> w
-> (Method, Text)
joinStakePool s w = endpoint @(Api.JoinStakePool Net) (\mk -> mk sid wid)
where
sid = s ^. typed @ApiPoolSpecifier
wid = w ^. typed @(ApiT WalletId)
quitStakePool :: forall w. HasType (ApiT WalletId) w => w -> (Method, Text)
quitStakePool w = endpoint @(Api.QuitStakePool Net) (wid &)
where
wid = w ^. typed @(ApiT WalletId)
getDelegationFee :: forall w. HasType (ApiT WalletId) w => w -> (Method, Text)
getDelegationFee w = endpoint @Api.DelegationFee (wid &)
where
wid = w ^. typed @(ApiT WalletId)
--
-- Network Information
--
getNetworkInfo :: (Method, Text)
getNetworkInfo = endpoint @Api.GetNetworkInformation id
getNetworkParams :: (Method, Text)
getNetworkParams = endpoint @Api.GetNetworkParameters id
getNetworkClock :: (Method, Text)
getNetworkClock = endpoint @Api.GetNetworkClock (False &)
getNetworkClock'
:: Bool -- ^ When 'True', block and force NTP check
-> (Method, Text)
getNetworkClock' forceNtpCheck = endpoint @Api.GetNetworkClock (forceNtpCheck &)
--
-- Proxy
--
postExternalTransaction :: (Method, Text)
postExternalTransaction = endpoint @Api.PostExternalTransaction id
--
-- Settings
--
putSettings :: (Method, Text)
putSettings = endpoint @Api.PutSettings id
getSettings :: (Method, Text)
getSettings = endpoint @Api.GetSettings id
--
-- Utils
--
getCurrentSMASHHealth :: (Method, Text)
getCurrentSMASHHealth = getCurrentSMASHHealth' Nothing
getCurrentSMASHHealth' :: Maybe SmashServer -> (Method, Text)
getCurrentSMASHHealth' smash =
endpoint @Api.GetCurrentSMASHHealth (\mk -> mk (ApiT <$> smash))
--
-- Shared Wallets
--
patchSharedWallet
:: forall w. HasType (ApiT WalletId) w
=> w
-> CredentialType
-> (Method, Text)
patchSharedWallet w cred =
case cred of
Payment ->
endpoint @Api.PatchSharedWalletInPayment (wid &)
Delegation ->
endpoint @Api.PatchSharedWalletInDelegation (wid &)
where
wid = w ^. typed @(ApiT WalletId)
--
-- Node
--
getBlocksLatestHeader :: (Method, Text)
getBlocksLatestHeader = endpoint @Api.GetBlocksLatestHeader id
--
-- Internals
--
-- | A safe endpoint creator. This extracts the endpoint from a given Api type
-- in the form of:
--
-- - A 'Text' string (the URL)
-- - An HTTP 'Method' for calling this endpoint (e.g. GET, POST, ...)
--
-- This function does not type-check if the given endpoint (via type
-- application) is not actually part of the wallet API.
--
-- Note that the 'MkLink endpoint Text' depends on the type of 'endpoint'.
--
-- - For simple endpoints with no path or query parameters we have:
--
-- @MkLink endpoint Text ~ Text@ and therefore, we can simply do
--
-- >>> endpoint @Api.ListWallets id
-- ( "GET", "v2/wallets" )
--
-- - For endpoints with parameters, 'MkLink endpoint Text' will be a function
-- taking as many arguments as there are path or query parameters (path
-- parameters going first).
--
-- >>> endpoint @Api.GetWallet (\(mk :: ApiT WalletId -> Text) -> mk wid)
-- ( "GET", "v2/wallets/2512a00e9653fe49a44a5886202e24d77eeb998f" )
--
-- Or, simply:
--
-- >>> endpoint @Api.GetWallet (wid &)
-- ( "GET", "v2/wallets/2512a00e9653fe49a44a5886202e24d77eeb998f" )
endpoint
:: forall endpoint.
( HasLink endpoint
, IsElem endpoint endpoint
, HasVerb endpoint
)
=> (MkLink endpoint Text -> Text)
-> (Method, Text)
endpoint mk =
( method (Proxy @endpoint)
, "v2/" <> mk (safeLink' toUrlPiece (Proxy @endpoint) (Proxy @endpoint))
)
-- Returns first argument for Shelley style wallet, second argument otherwise.
class Discriminate (style :: WalletStyle) where
discriminate :: a -> a -> a -> a
instance Discriminate 'Shelley where
discriminate a _ _ = a
instance Discriminate 'Byron where
discriminate _ a _ = a
instance Discriminate 'Shared where
discriminate _ _ a = a
notSupported :: HasCallStack => String -> a
notSupported style = error $ "Endpoint not supported for " <> style <> " style"
-- | Some endpoints are parameterized via a network discriminant in order to
-- correctly encode their end type (for example, 'CreateTransaction n'). Yet, in
-- the context of this module, the network discrimination doesn't matter for it
-- has no influence on the endpoint's value and/or path parameters.
--
-- To ease type signatures, we therefore arbitrarily fix the network to Mainnet.
type Net = 'Mainnet
-- | Extract the method from a given Api
class HasVerb api where
method :: Proxy api -> Method
instance (ReflectMethod m) => HasVerb (NoContentVerb m) where
method _ = reflectMethod (Proxy @m)
instance (ReflectMethod m) => HasVerb (Verb m s ct a) where
method _ = reflectMethod (Proxy @m)
instance HasVerb sub => HasVerb ((path :: Symbol) :> sub) where
method _ = method (Proxy @sub)
instance HasVerb sub => HasVerb (Capture' mods param t :> sub) where
method _ = method (Proxy @sub)
instance HasVerb sub => HasVerb (ReqBody a b :> sub) where
method _ = method (Proxy @sub)
instance HasVerb sub => HasVerb (QueryParam a b :> sub) where
method _ = method (Proxy @sub)
instance HasVerb sub => HasVerb (QueryFlag sym :> sub) where
method _ = method (Proxy @sub)
instance HasVerb sub => HasVerb (Header' opts name ty :> sub) where
method _ = method (Proxy @sub)