/
Types.hs
1258 lines (1084 loc) · 39.4 KB
/
Types.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
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedLists #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
{-# OPTIONS_GHC -Wno-orphans #-}
-- | This module defines the request and response types in the Marlowe Runtime
-- | Web API.
module Language.Marlowe.Runtime.Web.Types where
import Control.Applicative ((<|>))
import Control.Lens hiding ((.=))
import Control.Monad (unless, (<=<))
import Data.Aeson
import Data.Aeson.Text (encodeToLazyText)
import Data.Aeson.Types (Parser, parseFail, toJSONKeyText)
import Data.Bifunctor (first)
import Data.ByteString (ByteString)
import qualified Data.ByteString as BS
import Data.ByteString.Base16 (decodeBase16, encodeBase16)
import Data.Char (isSpace)
import Data.Foldable (fold)
import Data.Map (Map)
import qualified Data.Map as Map
import Data.OpenApi (
AdditionalProperties (..),
HasAdditionalProperties (..),
HasType (..),
NamedSchema (..),
OpenApiType (..),
Reference (..),
Referenced (..),
ToParamSchema,
ToSchema,
declareSchema,
declareSchemaRef,
enum_,
example,
oneOf,
pattern,
properties,
required,
toParamSchema,
)
import qualified Data.OpenApi as OpenApi
import Data.OpenApi.Schema (ToSchema (..))
import Data.Set (Set)
import Data.String (IsString (..))
import Data.Text (Text, intercalate, splitOn)
import qualified Data.Text as T
import Data.Text.Encoding (encodeUtf8)
import qualified Data.Text.Lazy as TL
import Data.Time (UTCTime)
import Data.Time.Format.ISO8601 (iso8601Show)
import Data.Traversable (for)
import Data.Version (Version)
import Data.Word (Word16, Word32, Word64)
import GHC.Exts (IsList)
import GHC.Generics (Generic)
import Language.Marlowe.Analysis.Safety.Types (SafetyError)
import qualified Language.Marlowe.Core.V1.Semantics.Types as Semantics
import Language.Marlowe.Object.Types (Label (..))
import Language.Marlowe.Runtime.Web.Orphans ()
import Network.URI (parseURI)
import Servant
import Servant.Pagination (HasPagination (..))
-- | A newtype for Base16 decoding and encoding ByteStrings
newtype Base16 = Base16 {unBase16 :: ByteString}
deriving (Eq, Ord)
instance Show Base16 where
show = T.unpack . encodeBase16 . unBase16
instance IsString Base16 where
fromString = either (error . T.unpack) Base16 . decodeBase16 . encodeUtf8 . T.pack
instance ToJSON Base16 where
toJSON = String . toUrlPiece
instance ToJSONKey Base16 where
toJSONKey = toJSONKeyText toUrlPiece
instance FromJSON Base16 where
parseJSON =
withText "Base16" $ either (parseFail . T.unpack) pure . parseUrlPiece
instance FromJSONKey Base16 where
fromJSONKey = FromJSONKeyTextParser $ either (parseFail . T.unpack) pure . parseUrlPiece
instance ToHttpApiData Base16 where
toUrlPiece = encodeBase16 . unBase16
instance FromHttpApiData Base16 where
parseUrlPiece = fmap Base16 . decodeBase16 . encodeUtf8
instance ToSchema Base16 where
declareNamedSchema _ = NamedSchema Nothing <$> declareSchema (Proxy @String)
data Assets = Assets
{ lovelace :: Integer
, tokens :: Tokens
}
deriving (Eq, Show, Ord, Generic)
deriving anyclass (ToJSON, FromJSON, ToSchema)
newtype Tokens = Tokens {unTokens :: Map PolicyId (Map Text Integer)}
deriving (Eq, Show, Ord, Generic)
deriving newtype (ToJSON, FromJSON, ToSchema)
newtype ContractSourceId = ContractSourceId {unContractSourceId :: ByteString}
deriving (Eq, Ord, Generic)
deriving (Show, ToHttpApiData, ToJSON) via Base16
instance FromHttpApiData ContractSourceId where
parseUrlPiece = fmap ContractSourceId . (hasLength 32 . unBase16 <=< parseUrlPiece)
instance FromJSON ContractSourceId where
parseJSON =
withText "ContractSourceId" $ either (parseFail . T.unpack) pure . parseUrlPiece
instance ToSchema ContractSourceId where
declareNamedSchema = pure . NamedSchema (Just "ContractSourceId") . toParamSchema
instance ToParamSchema ContractSourceId where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "The hex-encoded identifier of a Marlowe contract source"
& pattern ?~ "^[a-fA-F0-9]{64}$"
newtype TxId = TxId {unTxId :: ByteString}
deriving (Eq, Ord, Generic)
deriving (Show, ToHttpApiData, ToJSON) via Base16
instance FromHttpApiData TxId where
parseUrlPiece = fmap TxId . (hasLength 32 . unBase16 <=< parseUrlPiece)
instance FromJSON TxId where
parseJSON =
withText "TxId" $ either (parseFail . T.unpack) pure . parseUrlPiece
hasLength :: Int -> ByteString -> Either T.Text ByteString
hasLength l bytes
| BS.length bytes == l = pure bytes
| otherwise = Left $ "Expected " <> T.pack (show l) <> " bytes"
instance ToSchema TxId where
declareNamedSchema = pure . NamedSchema (Just "TxId") . toParamSchema
instance ToParamSchema TxId where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "The hex-encoded identifier of a Cardano transaction"
& pattern ?~ "^[a-fA-F0-9]{64}$"
newtype Address = Address {unAddress :: T.Text}
deriving (Eq, Ord, Generic)
deriving newtype (Show, ToHttpApiData, FromHttpApiData, ToJSON, FromJSON)
instance ToSchema Address where
declareNamedSchema = pure . NamedSchema (Just "Address") . toParamSchema
instance ToParamSchema Address where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "A cardano address, in Bech32 format"
& example ?~ "addr1w94f8ywk4fg672xasahtk4t9k6w3aql943uxz5rt62d4dvq8evxaf"
newtype StakeAddress = StakeAddress {unStakeAddress :: T.Text}
deriving (Eq, Ord, Generic)
deriving newtype (Show, ToHttpApiData, FromHttpApiData, ToJSON, FromJSON)
instance ToSchema StakeAddress where
declareNamedSchema = pure . NamedSchema (Just "StakeAddress") . toParamSchema
instance ToParamSchema StakeAddress where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "A cardano stake address, in Bech32 format"
& example ?~ "stake1ux7lyy9nhecm033qsmel9awnr22up6jadlzkrxufr78w82gsfsn0d"
newtype CommaList a = CommaList {unCommaList :: [a]}
deriving (Eq, Ord, Generic, Functor)
deriving newtype (Show, ToJSON, FromJSON, IsList)
instance ToParamSchema (CommaList a) where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "A comma-separated list of values"
instance (ToSchema a) => ToSchema (CommaList a)
instance (ToHttpApiData a) => ToHttpApiData (CommaList a) where
toUrlPiece = T.intercalate "," . fmap toUrlPiece . unCommaList
toQueryParam = T.intercalate "," . fmap toQueryParam . unCommaList
instance (FromHttpApiData a) => FromHttpApiData (CommaList a) where
parseUrlPiece =
fmap CommaList
. traverse (parseUrlPiece . T.dropWhileEnd isSpace . T.dropWhile isSpace)
. splitOnNonEmpty ","
parseQueryParam =
fmap CommaList
. traverse (parseQueryParam . T.dropWhileEnd isSpace . T.dropWhile isSpace)
. splitOnNonEmpty ","
splitOnNonEmpty :: Text -> Text -> [Text]
splitOnNonEmpty sep t
| T.null t = []
| otherwise = T.splitOn sep t
newtype PolicyId = PolicyId {unPolicyId :: ByteString}
deriving (Eq, Ord, Generic)
deriving (Show, ToHttpApiData, FromHttpApiData, ToJSON, ToJSONKey, FromJSON, FromJSONKey) via Base16
instance ToSchema PolicyId where
declareNamedSchema proxy = pure $ NamedSchema (Just "PolicyId") $ toParamSchema proxy
instance ToParamSchema PolicyId where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "The hex-encoded minting policy ID for a native Cardano token"
& pattern ?~ "^[a-fA-F0-9]*$"
data AssetId = AssetId
{ policyId :: PolicyId
, assetName :: Text
}
deriving (Show, Eq, Ord, Generic)
instance ToSchema AssetId
instance FromJSON AssetId
instance ToJSON AssetId
instance ToParamSchema AssetId where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description
?~ "A minting policy ID and a token name identifying a specific asset type. Encoded as policyId.tokenName."
& pattern ?~ "^[a-fA-F0-9]*\\..*$"
instance FromHttpApiData AssetId where
parseUrlPiece piece = case T.breakOn "." piece of
(_, "") -> Left "Expected ^[a-fA-F0-9]*(\\.).*$"
(policyId, tokenNameStartingWitPeriodCharacter) -> AssetId <$> parseUrlPiece policyId <*> parseUrlPiece (T.drop 1 tokenNameStartingWitPeriodCharacter)
instance ToHttpApiData AssetId where
toUrlPiece AssetId{..} = toUrlPiece policyId <> "." <> toUrlPiece assetName
newtype Party = Party {unParty :: T.Text}
deriving (Eq, Ord, Generic)
deriving newtype (Show, ToHttpApiData, FromHttpApiData, ToJSON, FromJSON)
instance ToSchema Party where
declareNamedSchema proxy = pure $ NamedSchema (Just "Party") $ toParamSchema proxy
instance ToParamSchema Party where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "Party (A role name or an Address)"
data TxOutRef = TxOutRef
{ txId :: TxId
, txIx :: Word16
}
deriving (Show, Eq, Ord, Generic)
instance FromHttpApiData TxOutRef where
parseUrlPiece t = case splitOn "#" t of
[idText, ixText] -> TxOutRef <$> parseUrlPiece idText <*> parseUrlPiece ixText
_ -> case parseUrlPiece @TxId t of
Right _ -> Left "Expected [a-fA-F0-9]{64}#[0-9]+ (hint: do you need to URL-encode the '#' as \"%23\"?)"
_ -> Left "Expected [a-fA-F0-9]{64}#[0-9]+"
instance ToHttpApiData TxOutRef where
toUrlPiece TxOutRef{..} = toUrlPiece txId <> "#" <> toUrlPiece txIx
instance FromJSON TxOutRef where
parseJSON =
withText "TxOutRef" $ either (parseFail . T.unpack) pure . parseUrlPiece
instance FromJSONKey TxOutRef where
fromJSONKey = FromJSONKeyTextParser $ either (parseFail . T.unpack) pure . parseUrlPiece
instance ToSchema TxOutRef where
declareNamedSchema _ =
pure $
NamedSchema (Just "TxOutRef") $
mempty
& type_ ?~ OpenApiString
& OpenApi.description
?~ "A reference to a transaction output with a transaction ID and index."
& pattern ?~ "^[a-fA-F0-9]{64}#[0-9]+$"
& example ?~ "98d601c9307dd43307cf68a03aad0086d4e07a789b66919ccf9f7f7676577eb7#1"
instance ToParamSchema TxOutRef where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& OpenApi.description
?~ "A reference to a transaction output with a transaction ID and index. The value must be URL encoded by replacing the '#' character with %23."
& pattern ?~ "^[a-fA-F0-9]{64}%23[0-9]+$"
& example ?~ "98d601c9307dd43307cf68a03aad0086d4e07a789b66919ccf9f7f7676577eb7%231"
instance ToJSON TxOutRef where
toJSON = String . toUrlPiece
instance ToJSONKey TxOutRef where
toJSONKey = toJSONKeyText toUrlPiece
data MarloweVersion = V1
deriving (Show, Eq, Ord)
instance ToJSON MarloweVersion where
toJSON V1 = String "v1"
instance FromJSON MarloweVersion where
parseJSON =
withText "MarloweVersion" $ either (parseFail . T.unpack) pure . parseUrlPiece
instance ToHttpApiData MarloweVersion where
toUrlPiece V1 = "v1"
instance FromHttpApiData MarloweVersion where
parseUrlPiece "v1" = Right V1
parseUrlPiece _ =
Left $
fold @[]
[ "expected one of "
, intercalate "; " ["v1"]
]
instance ToSchema MarloweVersion where
declareNamedSchema _ =
pure $
NamedSchema (Just "MarloweVersion") $
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "A version of the Marlowe language."
& enum_ ?~ ["v1"]
data Payout = Payout
{ payoutId :: TxOutRef
, role :: Text
, assets :: Assets
}
deriving (FromJSON, ToJSON, ToSchema, Show, Eq, Generic)
data ContractState = ContractState
{ contractId :: TxOutRef
, roleTokenMintingPolicyId :: PolicyId
, version :: MarloweVersion
, continuations :: Maybe Text
, tags :: Map Text Metadata
, metadata :: Map Word64 Metadata
, status :: TxStatus
, block :: Maybe BlockHeader
, initialContract :: Semantics.Contract
, currentContract :: Maybe Semantics.Contract
, state :: Maybe Semantics.State
, utxo :: Maybe TxOutRef
, assets :: Assets
, txBody :: Maybe TextEnvelope
, unclaimedPayouts :: [Payout]
}
deriving (Show, Eq, Generic)
instance ToJSON ContractState
instance FromJSON ContractState
instance ToSchema ContractState
data ContractHeader = ContractHeader
{ contractId :: TxOutRef
, roleTokenMintingPolicyId :: PolicyId
, version :: MarloweVersion
, continuations :: Maybe Text
, tags :: Map Text Metadata
, metadata :: Map Word64 Metadata
, status :: TxStatus
, block :: Maybe BlockHeader
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON ContractHeader
instance FromJSON ContractHeader
instance ToSchema ContractHeader
data WithdrawalHeader = WithdrawalHeader
{ withdrawalId :: TxId
, status :: TxStatus
, block :: Maybe BlockHeader
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON WithdrawalHeader
instance FromJSON WithdrawalHeader
instance ToSchema WithdrawalHeader
instance HasPagination WithdrawalHeader "withdrawalId" where
type RangeType WithdrawalHeader "withdrawalId" = TxId
getFieldValue _ WithdrawalHeader{..} = withdrawalId
data PayoutStatus
= Available
| Withdrawn
deriving (Show, Eq, Ord, Generic)
instance ToJSON PayoutStatus where
toJSON =
String . \case
Available -> "available"
Withdrawn -> "withdrawn"
instance FromJSON PayoutStatus where
parseJSON = withText "PayoutStatus" \str -> case T.toLower str of
"available" -> pure Available
"withdrawn" -> pure Withdrawn
_ -> fail "expected \"available\" or \"withdrawn\""
instance ToHttpApiData PayoutStatus where
toQueryParam = \case
Available -> "available"
Withdrawn -> "withdrawn"
instance FromHttpApiData PayoutStatus where
parseQueryParam str = case T.toLower str of
"available" -> pure Available
"withdrawn" -> pure Withdrawn
_ -> Left "expected \"available\" or \"withdrawn\""
instance ToSchema PayoutStatus where
declareNamedSchema = pure . NamedSchema (Just "PayoutStatus") . toParamSchema
instance ToParamSchema PayoutStatus where
toParamSchema _ =
mempty
& type_ ?~ OpenApiString
& enum_ ?~ ["available", "withdrawn"]
& OpenApi.description
?~ "The status of a payout. Either it is available to be withdrawn, or it has already been withdrawn."
data PayoutHeader = PayoutHeader
{ payoutId :: TxOutRef
, contractId :: TxOutRef
, withdrawalId :: Maybe TxId
, role :: AssetId
, status :: PayoutStatus
}
deriving (Show, Eq, Ord, Generic)
instance HasPagination PayoutHeader "payoutId" where
type RangeType PayoutHeader "payoutId" = TxOutRef
getFieldValue _ PayoutHeader{..} = payoutId
instance ToJSON PayoutHeader
instance FromJSON PayoutHeader
instance ToSchema PayoutHeader
data PayoutState = PayoutState
{ payoutId :: TxOutRef
, contractId :: TxOutRef
, withdrawalId :: Maybe TxId
, role :: AssetId
, payoutValidatorAddress :: Address
, status :: PayoutStatus
, assets :: Assets
}
deriving (FromJSON, ToJSON, ToSchema, Show, Eq, Generic)
data Withdrawal = Withdrawal
{ payouts :: Set PayoutHeader
, withdrawalId :: TxId
, status :: TxStatus
, block :: Maybe BlockHeader
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON Withdrawal
instance FromJSON Withdrawal
instance ToSchema Withdrawal
instance HasPagination ContractHeader "contractId" where
type RangeType ContractHeader "contractId" = TxOutRef
getFieldValue _ ContractHeader{..} = contractId
newtype Metadata = Metadata {unMetadata :: Value}
deriving (Show, Eq, Ord)
deriving newtype (ToJSON, FromJSON)
instance ToSchema Metadata where
declareNamedSchema _ =
pure $
NamedSchema (Just "Metadata") $
mempty
& OpenApi.description ?~ "An arbitrary JSON value for storage in a metadata key"
data TxHeader = TxHeader
{ contractId :: TxOutRef
, transactionId :: TxId
, continuations :: Maybe Text
, tags :: Map Text Metadata
, metadata :: Map Word64 Metadata
, status :: TxStatus
, block :: Maybe BlockHeader
, utxo :: Maybe TxOutRef
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON TxHeader
instance FromJSON TxHeader
instance ToSchema TxHeader
data Tx = Tx
{ contractId :: TxOutRef
, transactionId :: TxId
, continuations :: Maybe Text
, tags :: Map Text Metadata
, metadata :: Map Word64 Metadata
, status :: TxStatus
, block :: Maybe BlockHeader
, inputUtxo :: TxOutRef
, inputs :: [Semantics.Input]
, outputUtxo :: Maybe TxOutRef
, outputContract :: Maybe Semantics.Contract
, outputState :: Maybe Semantics.State
, assets :: Assets
, payouts :: [Payout]
, consumingTx :: Maybe TxId
, invalidBefore :: UTCTime
, invalidHereafter :: UTCTime
, txBody :: Maybe TextEnvelope
}
deriving (Show, Eq, Generic)
instance ToJSON Tx
instance FromJSON Tx
instance ToSchema Tx
instance HasPagination TxHeader "transactionId" where
type RangeType TxHeader "transactionId" = TxId
getFieldValue _ TxHeader{..} = transactionId
data TxStatus
= Unsigned
| Submitted
| Confirmed
deriving (Show, Eq, Ord)
instance ToJSON TxStatus where
toJSON Unsigned = String "unsigned"
toJSON Submitted = String "submitted"
toJSON Confirmed = String "confirmed"
instance FromJSON TxStatus where
parseJSON (String "unsigned") = pure Unsigned
parseJSON (String "submitted") = pure Submitted
parseJSON (String "confirmed") = pure Confirmed
parseJSON _ = parseFail "invalid status"
instance ToSchema TxStatus where
declareNamedSchema _ =
pure $
NamedSchema (Just "TxStatus") $
mempty
& type_ ?~ OpenApiString
& enum_ ?~ ["unsigned", "submitted", "confirmed"]
& OpenApi.description ?~ "The status of a transaction on the local node."
data BlockHeader = BlockHeader
{ slotNo :: Word64
, blockNo :: Word64
, blockHeaderHash :: Base16
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON BlockHeader
instance FromJSON BlockHeader
instance ToSchema BlockHeader
data CardanoTx
data CardanoTxBody
data WithdrawTxEnvelope tx = WithdrawTxEnvelope
{ withdrawalId :: TxId
, txEnvelope :: TextEnvelope
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON (WithdrawTxEnvelope CardanoTx) where
toJSON WithdrawTxEnvelope{..} =
object
[ ("withdrawalId", toJSON withdrawalId)
, ("tx", toJSON txEnvelope)
]
instance ToJSON (WithdrawTxEnvelope CardanoTxBody) where
toJSON WithdrawTxEnvelope{..} =
object
[ ("withdrawalId", toJSON withdrawalId)
, ("txBody", toJSON txEnvelope)
]
instance FromJSON (WithdrawTxEnvelope CardanoTx) where
parseJSON = withObject "WithdrawTxEnvelope" \obj ->
WithdrawTxEnvelope
<$> obj .: "withdrawalId"
<*> obj .: "tx"
instance FromJSON (WithdrawTxEnvelope CardanoTxBody) where
parseJSON = withObject "WithdrawTxEnvelope" \obj ->
WithdrawTxEnvelope
<$> obj .: "withdrawalId"
<*> obj .: "txBody"
instance ToSchema (WithdrawTxEnvelope CardanoTx) where
declareNamedSchema _ = do
withdrawalIdSchema <- declareSchemaRef (Proxy :: Proxy TxId)
txEnvelopeSchema <- declareSchemaRef (Proxy :: Proxy TextEnvelope)
return $
NamedSchema (Just "WithdrawTxEnvelope") $
mempty
& type_ ?~ OpenApiObject
& OpenApi.description ?~ "The \"type\" property of \"tx\" must be \"Tx BabbageEra\" or \"Tx ConwayEra\""
& properties
.~ [ ("withdrawalId", withdrawalIdSchema)
, ("tx", txEnvelopeSchema)
]
& required .~ ["withdrawalId", "tx"]
instance ToSchema (WithdrawTxEnvelope CardanoTxBody) where
declareNamedSchema _ = do
withdrawalIdSchema <- declareSchemaRef (Proxy :: Proxy TxId)
txEnvelopeSchema <- declareSchemaRef (Proxy :: Proxy TextEnvelope)
return $
NamedSchema (Just "WithdrawTxBodyEnvelope") $
mempty
& type_ ?~ OpenApiObject
& OpenApi.description ?~ "The \"type\" property of \"txBody\" must be \"TxBody BabbageEra\" or \"TxBody ConwayEra\""
& properties
.~ [ ("withdrawalId", withdrawalIdSchema)
, ("txBody", txEnvelopeSchema)
]
& required .~ ["withdrawalId", "txBody"]
data CreateTxEnvelope tx = CreateTxEnvelope
{ contractId :: TxOutRef
, txEnvelope :: TextEnvelope
, safetyErrors :: [SafetyError]
}
deriving (Show, Eq, Generic)
instance ToJSON (CreateTxEnvelope CardanoTx) where
toJSON CreateTxEnvelope{..} =
object
[ ("contractId", toJSON contractId)
, ("tx", toJSON txEnvelope)
, ("safetyErrors", toJSON safetyErrors)
]
instance ToJSON (CreateTxEnvelope CardanoTxBody) where
toJSON CreateTxEnvelope{..} =
object
[ ("contractId", toJSON contractId)
, ("txBody", toJSON txEnvelope)
, ("safetyErrors", toJSON safetyErrors)
]
instance FromJSON (CreateTxEnvelope CardanoTx) where
parseJSON = withObject "CreateTxEnvelope" \obj ->
CreateTxEnvelope
<$> obj .: "contractId"
<*> obj .: "tx"
<*> obj .: "safetyErrors"
instance FromJSON (CreateTxEnvelope CardanoTxBody) where
parseJSON = withObject "CreateTxEnvelope" \obj ->
CreateTxEnvelope
<$> obj .: "contractId"
<*> obj .: "txBody"
<*> obj .: "safetyErrors"
instance ToSchema (CreateTxEnvelope CardanoTx) where
declareNamedSchema _ = do
contractIdSchema <- declareSchemaRef (Proxy :: Proxy TxOutRef)
txEnvelopeSchema <- declareSchemaRef (Proxy :: Proxy TextEnvelope)
safetyErrorsSchema <- declareSchemaRef (Proxy :: Proxy [SafetyError])
return $
NamedSchema (Just "CreateTxEnvelope") $
mempty
& type_ ?~ OpenApiObject
& OpenApi.description ?~ "The \"type\" property of \"tx\" must be \"Tx BabbageEra\" or \"Tx ConwayEra\""
& properties
.~ [ ("contractId", contractIdSchema)
, ("tx", txEnvelopeSchema)
, ("safetyErrors", safetyErrorsSchema)
]
& required .~ ["contractId", "tx"]
instance ToSchema (CreateTxEnvelope CardanoTxBody) where
declareNamedSchema _ = do
contractIdSchema <- declareSchemaRef (Proxy :: Proxy TxOutRef)
txEnvelopeSchema <- declareSchemaRef (Proxy :: Proxy TextEnvelope)
safetyErrorsSchema <- declareSchemaRef (Proxy :: Proxy [SafetyError])
return $
NamedSchema (Just "CreateTxBodyEnvelope") $
mempty
& type_ ?~ OpenApiObject
& OpenApi.description ?~ "The \"type\" property of \"txBody\" must be \"TxBody BabbageEra\" or \"TxBody ConwayEra\""
& properties
.~ [ ("contractId", contractIdSchema)
, ("txBody", txEnvelopeSchema)
, ("safetyErrors", safetyErrorsSchema)
]
& required .~ ["contractId", "txBody"]
data TextEnvelope = TextEnvelope
{ teType :: Text
, teDescription :: Text
, teCborHex :: Base16
}
deriving (Show, Eq, Ord, Generic)
instance ToJSON TextEnvelope where
toJSON TextEnvelope{..} =
object
[ ("type", toJSON teType)
, ("description", toJSON teDescription)
, ("cborHex", toJSON teCborHex)
]
instance FromJSON TextEnvelope where
parseJSON = withObject "TextEnvelope" \obj ->
TextEnvelope
<$> obj .: "type"
<*> obj .: "description"
<*> obj .: "cborHex"
instance ToSchema TextEnvelope where
declareNamedSchema _ = do
textSchema <- declareSchemaRef (Proxy @Text)
let typeSchema =
mempty
& type_ ?~ OpenApiString
& OpenApi.description
?~ "What type of data is encoded in the CBOR Hex. Valid values include \"Tx <era>\", \"TxBody <era>\", and \"ShelleyTxWitness <era>\" where <era> is one of \"BabbageEra\", \"ConwayEra\"."
pure $
NamedSchema (Just "TextEnvelope") $
mempty
& type_ ?~ OpenApiObject
& required .~ ["type", "description", "cborHex"]
& properties
.~ [ ("type", Inline typeSchema)
, ("description", textSchema)
, ("cborHex", textSchema)
]
data PostContractSourceResponse = PostContractSourceResponse
{ contractSourceId :: ContractSourceId
, intermediateIds :: Map Label ContractSourceId
}
deriving (Show, Eq, Ord, Generic)
instance FromJSON PostContractSourceResponse
instance ToJSON PostContractSourceResponse
instance ToSchema PostContractSourceResponse
newtype PostWithdrawalsRequest = PostWithdrawalsRequest
{ payouts :: Set TxOutRef
}
deriving (Show, Eq, Ord, Generic)
instance FromJSON PostWithdrawalsRequest
instance ToJSON PostWithdrawalsRequest
instance ToSchema PostWithdrawalsRequest
data PostContractsRequest = PostContractsRequest
{ tags :: Map Text Metadata
, metadata :: Map Word64 Metadata
, version :: MarloweVersion
, roles :: Maybe RolesConfig
, threadTokenName :: Maybe Text
, contract :: ContractOrSourceId
, minUTxODeposit :: Maybe Word64
}
deriving (Show, Eq, Ord, Generic)
instance FromJSON PostContractsRequest
instance ToJSON PostContractsRequest
instance ToSchema PostContractsRequest
newtype ContractOrSourceId = ContractOrSourceId (Either Semantics.Contract ContractSourceId)
deriving (Show, Eq, Ord, Generic)
instance FromJSON ContractOrSourceId where
parseJSON =
fmap ContractOrSourceId . \case
String "close" -> pure $ Left Semantics.Close
String s -> Right <$> parseJSON (String s)
j -> Left <$> parseJSON j
instance ToJSON ContractOrSourceId where
toJSON = \case
ContractOrSourceId (Left contract) -> toJSON contract
ContractOrSourceId (Right hash) -> toJSON hash
instance ToSchema ContractOrSourceId where
declareNamedSchema _ = do
contractSchema <- declareSchemaRef $ Proxy @Semantics.Contract
contractSourceIdSchema <- declareSchemaRef $ Proxy @ContractSourceId
pure $
NamedSchema Nothing $
mempty
& oneOf ?~ [contractSchema, contractSourceIdSchema]
data RolesConfig
= UsePolicy PolicyId
| UsePolicyWithOpenRoles PolicyId [Text]
| Mint (Map Text RoleTokenConfig)
deriving (Show, Eq, Ord, Generic)
instance FromJSON RolesConfig where
parseJSON (String s) = UsePolicy <$> parseJSON (String s)
parseJSON value =
withObject
"RolesConfig"
( \obj ->
let parseMint = Mint <$> parseJSON value
parseOpen =
do
script <- obj .: "script"
unless (script == ("OpenRole" :: String)) $ fail "AllowedValues: \"OpenRole\""
UsePolicyWithOpenRoles <$> obj .: "policyId" <*> obj .: "openRoleNames"
in parseOpen <|> parseMint
)
value
instance ToJSON RolesConfig where
toJSON (UsePolicy policy) = toJSON policy
toJSON (UsePolicyWithOpenRoles policy openRoleNames) =
object
[ "script" .= ("OpenRole" :: String)
, "policyId" .= policy
, "openRoleNames" .= openRoleNames
]
toJSON (Mint configs) = toJSON configs
instance ToSchema RolesConfig where
declareNamedSchema _ = do
policySchema <- declareSchemaRef (Proxy @PolicyId)
mintSchema <- declareSchemaRef (Proxy @(Map Text RoleTokenConfig))
pure $
NamedSchema (Just "RolesConfig") $
mempty
& oneOf ?~ [policySchema, mintSchema]
data RoleTokenConfig = RoleTokenConfig
{ recipients :: RoleTokenRecipients
, metadata :: Maybe TokenMetadata
}
deriving (Show, Eq, Ord, Generic)
type RoleTokenRecipients = Map RoleTokenRecipient Word64
data RoleTokenRecipient
= ClosedRole Address
| OpenRole
deriving (Show, Eq, Ord, Generic)
roleTokenRecipientToText :: RoleTokenRecipient -> Text
roleTokenRecipientToText = \case
ClosedRole addr -> unAddress addr
OpenRole -> "OpenRole"
roleTokenRecipientFromText :: Text -> RoleTokenRecipient
roleTokenRecipientFromText = \case
"OpenRole" -> OpenRole
addr -> ClosedRole $ Address addr
instance ToJSON RoleTokenRecipient where
toJSON = String . roleTokenRecipientToText
instance ToJSONKey RoleTokenRecipient where
toJSONKey = toJSONKeyText roleTokenRecipientToText
instance FromJSON RoleTokenRecipient where
parseJSON = withText "RoleTokenRecipient" $ pure . roleTokenRecipientFromText
instance FromJSONKey RoleTokenRecipient where
fromJSONKey = FromJSONKeyText roleTokenRecipientFromText
instance FromJSON RoleTokenConfig where
parseJSON (String "OpenRole") =
pure
. flip RoleTokenConfig Nothing
$ Map.singleton OpenRole 1
parseJSON (String s) =
pure
. flip RoleTokenConfig Nothing
. flip Map.singleton 1
. ClosedRole
$ Address s
parseJSON value =
withObject
"RoleTokenConfig"
( \obj -> do
mRecipients <- obj .:? "recipients"
mAddress <- obj .:? "address"
mScriptRole <- do
mScript :: Maybe String <- obj .:? "script"
for mScript \case
"OpenRole" -> pure OpenRole
_ -> fail "Expected \'OpenRole\""
metadata <- obj .:? "metadata"
recipients <- case (mRecipients, mAddress, mScriptRole) of
(Just recipients, _, _) -> pure recipients
(_, Just address, _) -> pure $ Map.singleton (ClosedRole address) 1
(_, _, Just scriptRole) -> pure $ Map.singleton scriptRole 1
_ -> fail "one of recipients, address, or script required"
pure RoleTokenConfig{..}
)
value
instance ToJSON RoleTokenConfig where
toJSON (RoleTokenConfig recipients metadata) =
object
[ "recipients" .= recipients
, "metadata" .= metadata
]
instance ToSchema RoleTokenConfig where
declareNamedSchema _ = do
simpleSchema <- declareSchemaRef (Proxy @Address)
metadataSchema <- declareSchemaRef (Proxy @TokenMetadata)
quantitySchema <- declareSchemaRef (Proxy @Word64)
let multiSchema =
mempty
& type_ ?~ OpenApiObject
& required .~ ["recipients"]
& properties
.~ [
( "recipients"
, Inline $
mempty
& type_ ?~ OpenApiObject
& additionalProperties ?~ AdditionalPropertiesSchema quantitySchema
)
, ("metadata", metadataSchema)
]
advancedSchema =
mempty
& type_ ?~ OpenApiObject
& required .~ ["address"]
& properties
.~ [ ("address", simpleSchema)
, ("metadata", metadataSchema)
]
scriptSchema =
mempty
& type_ ?~ OpenApiString
& OpenApi.description ?~ "The type of script receiving the role token."
& enum_ ?~ ["OpenRole"]
openSchema =
mempty
& type_ ?~ OpenApiObject
& required .~ ["script"]
& properties
.~ [ ("script", Inline scriptSchema)
, ("metadata", metadataSchema)
]
pure $
NamedSchema (Just "RoleTokenConfig") $
mempty
& oneOf ?~ [Inline multiSchema, simpleSchema, Inline advancedSchema, Inline openSchema]
data TokenMetadata = TokenMetadata
{ name :: Text
, image :: URI
, mediaType :: Maybe Text
, description :: Maybe Text
, files :: Maybe [TokenMetadataFile]
}
deriving (Show, Eq, Ord, Generic)
instance FromJSON TokenMetadata where
parseJSON = withObject "TokenMetadata" \obj -> do
imageJSON <- obj .: "image"
TokenMetadata
<$> obj .: "name"
<*> uriFromJSON imageJSON
<*> obj .:? "mediaType"