@percayso-community/cayso-contracts 0.30.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +33 -13
  2. package/dist/assertion.d.ts +43 -0
  3. package/dist/authority.d.ts +221 -0
  4. package/dist/authority.js +49 -0
  5. package/dist/client.d.ts +44 -3
  6. package/dist/client.js +17 -4
  7. package/dist/cloud-settlement.d.ts +8 -5
  8. package/dist/contract-schema.generated.js +567 -1
  9. package/dist/errors.d.ts +13 -2
  10. package/dist/index.d.ts +58 -4
  11. package/dist/index.js +57 -4
  12. package/dist/operator.d.ts +136 -5
  13. package/dist/operator.js +6 -1
  14. package/dist/schema-types.d.ts +3 -3
  15. package/package.json +1 -1
package/dist/contract-schema.generated.js CHANGED
@@ -14,7 +14,7 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  export const CONTRACT_SCHEMA = {
17
- "contractVersion": "0.30.0",
17
+ "contractVersion": "1.0.0",
18
18
  "packageName": "@percayso-community/cayso-contracts",
19
19
  "capabilities": {
20
20
  "wallet": "cayso.wallet",
@@ -358,6 +358,13 @@ export const CONTRACT_SCHEMA = {
358
358
  },
359
359
  "readonly": true,
360
360
  "optional": true
361
+ },
362
+ "auth_time": {
363
+ "type": {
364
+ "scalar": "number"
365
+ },
366
+ "readonly": true,
367
+ "optional": true
361
368
  }
362
369
  }
363
370
  },
@@ -460,6 +467,128 @@ export const CONTRACT_SCHEMA = {
460
467
  }
461
468
  }
462
469
  },
470
+ "AuthorityBindingRefusal": {
471
+ "kind": "alias",
472
+ "of": {
473
+ "union": [
474
+ {
475
+ "literal": "authority_assertion_missing"
476
+ },
477
+ {
478
+ "literal": "authority_assertion_invalid"
479
+ },
480
+ {
481
+ "literal": "subject_mismatch"
482
+ },
483
+ {
484
+ "literal": "operation_not_in_scope"
485
+ },
486
+ {
487
+ "literal": "operation_not_the_routes"
488
+ },
489
+ {
490
+ "literal": "auth_time_mismatch"
491
+ },
492
+ {
493
+ "literal": "not_jointly_current"
494
+ }
495
+ ]
496
+ }
497
+ },
498
+ "AuthorityClaims": {
499
+ "kind": "object",
500
+ "properties": {
501
+ "iss": {
502
+ "type": {
503
+ "scalar": "string"
504
+ },
505
+ "readonly": true,
506
+ "optional": false
507
+ },
508
+ "aud": {
509
+ "type": {
510
+ "literal": "cayso"
511
+ },
512
+ "readonly": true,
513
+ "optional": false
514
+ },
515
+ "jti": {
516
+ "type": {
517
+ "scalar": "string"
518
+ },
519
+ "readonly": true,
520
+ "optional": false
521
+ },
522
+ "iat": {
523
+ "type": {
524
+ "scalar": "number"
525
+ },
526
+ "readonly": true,
527
+ "optional": false
528
+ },
529
+ "exp": {
530
+ "type": {
531
+ "scalar": "number"
532
+ },
533
+ "readonly": true,
534
+ "optional": false
535
+ },
536
+ "sub": {
537
+ "type": {
538
+ "scalar": "string"
539
+ },
540
+ "readonly": true,
541
+ "optional": false
542
+ },
543
+ "operation": {
544
+ "type": {
545
+ "ref": "ContractOperation"
546
+ },
547
+ "readonly": true,
548
+ "optional": false
549
+ },
550
+ "organisationId": {
551
+ "type": {
552
+ "scalar": "string"
553
+ },
554
+ "readonly": true,
555
+ "optional": false
556
+ },
557
+ "mandateVersion": {
558
+ "type": {
559
+ "scalar": "number"
560
+ },
561
+ "readonly": true,
562
+ "optional": false
563
+ },
564
+ "auth_time": {
565
+ "type": {
566
+ "scalar": "number"
567
+ },
568
+ "readonly": true,
569
+ "optional": false
570
+ }
571
+ }
572
+ },
573
+ "AuthorityEnvelope": {
574
+ "kind": "object",
575
+ "properties": {
576
+ "header": {
577
+ "type": {
578
+ "ref": "AssertionHeader"
579
+ },
580
+ "readonly": true,
581
+ "optional": false
582
+ },
583
+ "claims": {
584
+ "type": {
585
+ "ref": "AuthorityClaims"
586
+ },
587
+ "readonly": true,
588
+ "optional": false
589
+ }
590
+ }
591
+ },
463
592
  "Balance": {
464
593
  "kind": "object",
465
594
  "properties": {
@@ -804,6 +933,9 @@ export const CONTRACT_SCHEMA = {
804
933
  {
805
934
  "literal": "contribution_store_issuer_not_configured"
806
935
  },
936
+ {
937
+ "literal": "authority_issuer_not_configured"
938
+ },
807
939
  {
808
940
  "literal": "cloud_settlement_store_not_configured"
809
941
  },
@@ -878,6 +1010,9 @@ export const CONTRACT_SCHEMA = {
878
1010
  },
879
1011
  {
880
1012
  "ref": "SettlementAssertionRefusal"
1013
+ },
1014
+ {
1015
+ "ref": "AuthorityBindingRefusal"
881
1016
  }
882
1017
  ]
883
1018
  }
@@ -4929,6 +5064,11 @@ export const CONTRACT_SCHEMA = {
4929
5064
  "method": "GET",
4930
5065
  "path": "/api/operator/quickenings",
4931
5066
  "scope": "read-quickening-ladder-as-operator"
5067
+ },
5068
+ "summary": {
5069
+ "method": "GET",
5070
+ "path": "/api/operator/summary",
5071
+ "scope": "read-economy-summary-as-operator"
4932
5072
  }
4933
5073
  },
4934
5074
  "types": {
@@ -5050,6 +5190,248 @@ export const CONTRACT_SCHEMA = {
5050
5190
  ]
5051
5191
  }
5052
5192
  },
5193
+ "OperatorEconomySummary": {
5194
+ "kind": "object",
5195
+ "properties": {
5196
+ "asOf": {
5197
+ "type": {
5198
+ "scalar": "string"
5199
+ },
5200
+ "readonly": true,
5201
+ "optional": false
5202
+ },
5203
+ "wallets": {
5204
+ "type": {
5205
+ "ref": "OperatorWalletCounts"
5206
+ },
5207
+ "readonly": true,
5208
+ "optional": false
5209
+ },
5210
+ "supply": {
5211
+ "type": {
5212
+ "ref": "OperatorSupplySummary"
5213
+ },
5214
+ "readonly": true,
5215
+ "optional": false
5216
+ },
5217
+ "movements": {
5218
+ "type": {
5219
+ "ref": "OperatorMovementCounts"
5220
+ },
5221
+ "readonly": true,
5222
+ "optional": false
5223
+ },
5224
+ "purchases": {
5225
+ "type": {
5226
+ "ref": "OperatorPurchaseCounts"
5227
+ },
5228
+ "readonly": true,
5229
+ "optional": false
5230
+ }
5231
+ }
5232
+ },
5233
+ "OperatorEconomySummaryError": {
5234
+ "kind": "object",
5235
+ "properties": {
5236
+ "error": {
5237
+ "type": {
5238
+ "ref": "OperatorEconomySummaryErrorCode"
5239
+ },
5240
+ "readonly": true,
5241
+ "optional": false
5242
+ }
5243
+ }
5244
+ },
5245
+ "OperatorEconomySummaryErrorCode": {
5246
+ "kind": "alias",
5247
+ "of": {
5248
+ "union": [
5249
+ {
5250
+ "ref": "OperatorAuthenticationRefusal"
5251
+ },
5252
+ {
5253
+ "ref": "OperatorAccessRefusal"
5254
+ },
5255
+ {
5256
+ "ref": "OperatorRateLimited"
5257
+ },
5258
+ {
5259
+ "ref": "OperatorReadUnavailable"
5260
+ },
5261
+ {
5262
+ "ref": "OperatorEconomySummaryUnavailable"
5263
+ },
5264
+ {
5265
+ "ref": "OperatorReadFailed"
5266
+ }
5267
+ ]
5268
+ }
5269
+ },
5270
+ "OperatorEconomySummaryResponse": {
5271
+ "kind": "alias",
5272
+ "of": {
5273
+ "union": [
5274
+ {
5275
+ "ref": "OperatorEconomySummary"
5276
+ },
5277
+ {
5278
+ "ref": "OperatorVerificationRefused"
5279
+ },
5280
+ {
5281
+ "ref": "OperatorEconomySummaryError"
5282
+ }
5283
+ ]
5284
+ }
5285
+ },
5286
+ "OperatorEconomySummaryUnavailable": {
5287
+ "kind": "alias",
5288
+ "of": {
5289
+ "literal": "operator_summary_reader_not_configured"
5290
+ }
5291
+ },
5292
+ "OperatorMovementCounts": {
5293
+ "kind": "object",
5294
+ "properties": {
5295
+ "total": {
5296
+ "type": {
5297
+ "scalar": "number"
5298
+ },
5299
+ "readonly": true,
5300
+ "optional": false
5301
+ },
5302
+ "inLast7Days": {
5303
+ "type": {
5304
+ "scalar": "number"
5305
+ },
5306
+ "readonly": true,
5307
+ "optional": false
5308
+ },
5309
+ "inLast30Days": {
5310
+ "type": {
5311
+ "scalar": "number"
5312
+ },
5313
+ "readonly": true,
5314
+ "optional": false
5315
+ },
5316
+ "byKind": {
5317
+ "type": {
5318
+ "ref": "OperatorMovementCountsByKind"
5319
+ },
5320
+ "readonly": true,
5321
+ "optional": false
5322
+ }
5323
+ }
5324
+ },
5325
+ "OperatorMovementCountsByKind": {
5326
+ "kind": "object",
5327
+ "properties": {
5328
+ "issuance": {
5329
+ "type": {
5330
+ "scalar": "number"
5331
+ },
5332
+ "readonly": true,
5333
+ "optional": false
5334
+ },
5335
+ "purchase": {
5336
+ "type": {
5337
+ "scalar": "number"
5338
+ },
5339
+ "readonly": true,
5340
+ "optional": false
5341
+ },
5342
+ "grant": {
5343
+ "type": {
5344
+ "scalar": "number"
5345
+ },
5346
+ "readonly": true,
5347
+ "optional": false
5348
+ },
5349
+ "charge": {
5350
+ "type": {
5351
+ "scalar": "number"
5352
+ },
5353
+ "readonly": true,
5354
+ "optional": false
5355
+ },
5356
+ "payout": {
5357
+ "type": {
5358
+ "scalar": "number"
5359
+ },
5360
+ "readonly": true,
5361
+ "optional": false
5362
+ },
5363
+ "transfer": {
5364
+ "type": {
5365
+ "scalar": "number"
5366
+ },
5367
+ "readonly": true,
5368
+ "optional": false
5369
+ },
5370
+ "burn": {
5371
+ "type": {
5372
+ "scalar": "number"
5373
+ },
5374
+ "readonly": true,
5375
+ "optional": false
5376
+ },
5377
+ "forfeit": {
5378
+ "type": {
5379
+ "scalar": "number"
5380
+ },
5381
+ "readonly": true,
5382
+ "optional": false
5383
+ },
5384
+ "commercial_payment": {
5385
+ "type": {
5386
+ "scalar": "number"
5387
+ },
5388
+ "readonly": true,
5389
+ "optional": false
5390
+ },
5391
+ "quoted_sale": {
5392
+ "type": {
5393
+ "scalar": "number"
5394
+ },
5395
+ "readonly": true,
5396
+ "optional": false
5397
+ },
5398
+ "buy_back": {
5399
+ "type": {
5400
+ "scalar": "number"
5401
+ },
5402
+ "readonly": true,
5403
+ "optional": false
5404
+ },
5405
+ "quoted_sale_compensation": {
5406
+ "type": {
5407
+ "scalar": "number"
5408
+ },
5409
+ "readonly": true,
5410
+ "optional": false
5411
+ },
5412
+ "marketplace_settlement": {
5413
+ "type": {
5414
+ "scalar": "number"
5415
+ },
5416
+ "readonly": true,
5417
+ "optional": false
5418
+ },
5419
+ "contribution_settlement": {
5420
+ "type": {
5421
+ "scalar": "number"
5422
+ },
5423
+ "readonly": true,
5424
+ "optional": false
5425
+ },
5426
+ "consumption_settlement": {
5427
+ "type": {
5428
+ "scalar": "number"
5429
+ },
5430
+ "readonly": true,
5431
+ "optional": false
5432
+ }
5433
+ }
5434
+ },
5053
5435
  "OperatorMovementRow": {
5054
5436
  "kind": "object",
5055
5437
  "properties": {
@@ -5352,6 +5734,65 @@ export const CONTRACT_SCHEMA = {
5352
5734
  "literal": "operator_movements_reader_not_configured"
5353
5735
  }
5354
5736
  },
5737
+ "OperatorPurchaseCounts": {
5738
+ "kind": "object",
5739
+ "properties": {
5740
+ "total": {
5741
+ "type": {
5742
+ "scalar": "number"
5743
+ },
5744
+ "readonly": true,
5745
+ "optional": false
5746
+ },
5747
+ "byStatus": {
5748
+ "type": {
5749
+ "ref": "OperatorPurchaseCountsByStatus"
5750
+ },
5751
+ "readonly": true,
5752
+ "optional": false
5753
+ }
5754
+ }
5755
+ },
5756
+ "OperatorPurchaseCountsByStatus": {
5757
+ "kind": "object",
5758
+ "properties": {
5759
+ "pending": {
5760
+ "type": {
5761
+ "scalar": "number"
5762
+ },
5763
+ "readonly": true,
5764
+ "optional": false
5765
+ },
5766
+ "issued_uncaptured": {
5767
+ "type": {
5768
+ "scalar": "number"
5769
+ },
5770
+ "readonly": true,
5771
+ "optional": false
5772
+ },
5773
+ "succeeded": {
5774
+ "type": {
5775
+ "scalar": "number"
5776
+ },
5777
+ "readonly": true,
5778
+ "optional": false
5779
+ },
5780
+ "failed": {
5781
+ "type": {
5782
+ "scalar": "number"
5783
+ },
5784
+ "readonly": true,
5785
+ "optional": false
5786
+ },
5787
+ "cancelled": {
5788
+ "type": {
5789
+ "scalar": "number"
5790
+ },
5791
+ "readonly": true,
5792
+ "optional": false
5793
+ }
5794
+ }
5795
+ },
5355
5796
  "OperatorPurchaseRow": {
5356
5797
  "kind": "object",
5357
5798
  "properties": {
@@ -5693,6 +6134,9 @@ export const CONTRACT_SCHEMA = {
5693
6134
  },
5694
6135
  {
5695
6136
  "literal": "read-quickening-ladder-as-operator"
6137
+ },
6138
+ {
6139
+ "literal": "read-economy-summary-as-operator"
5696
6140
  }
5697
6141
  ]
5698
6142
  }
@@ -5713,6 +6157,81 @@ export const CONTRACT_SCHEMA = {
5713
6157
  ]
5714
6158
  }
5715
6159
  },
6160
+ "OperatorSupplySummary": {
6161
+ "kind": "object",
6162
+ "properties": {
6163
+ "totalMintedCents": {
6164
+ "type": {
6165
+ "ref": "Cents"
6166
+ },
6167
+ "readonly": true,
6168
+ "optional": false
6169
+ },
6170
+ "cancelledCents": {
6171
+ "type": {
6172
+ "ref": "Cents"
6173
+ },
6174
+ "readonly": true,
6175
+ "optional": false
6176
+ },
6177
+ "heldCents": {
6178
+ "type": {
6179
+ "ref": "Cents"
6180
+ },
6181
+ "readonly": true,
6182
+ "optional": false
6183
+ },
6184
+ "restrictedCents": {
6185
+ "type": {
6186
+ "ref": "Cents"
6187
+ },
6188
+ "readonly": true,
6189
+ "optional": false
6190
+ },
6191
+ "unrestrictedCents": {
6192
+ "type": {
6193
+ "ref": "Cents"
6194
+ },
6195
+ "readonly": true,
6196
+ "optional": false
6197
+ },
6198
+ "inCitizenWalletsCents": {
6199
+ "type": {
6200
+ "ref": "Cents"
6201
+ },
6202
+ "readonly": true,
6203
+ "optional": false
6204
+ },
6205
+ "inOrganisationWalletsCents": {
6206
+ "type": {
6207
+ "ref": "Cents"
6208
+ },
6209
+ "readonly": true,
6210
+ "optional": false
6211
+ },
6212
+ "inFounderWalletsCents": {
6213
+ "type": {
6214
+ "ref": "Cents"
6215
+ },
6216
+ "readonly": true,
6217
+ "optional": false
6218
+ },
6219
+ "inTreasuryCents": {
6220
+ "type": {
6221
+ "union": [
6222
+ {
6223
+ "ref": "Cents"
6224
+ },
6225
+ {
6226
+ "null": true
6227
+ }
6228
+ ]
6229
+ },
6230
+ "readonly": true,
6231
+ "optional": false
6232
+ }
6233
+ }
6234
+ },
5716
6235
  "OperatorVerificationRefused": {
5717
6236
  "kind": "object",
5718
6237
  "properties": {
@@ -5732,6 +6251,53 @@ export const CONTRACT_SCHEMA = {
5732
6251
  }
5733
6252
  }
5734
6253
  },
6254
+ "OperatorWalletCounts": {
6255
+ "kind": "object",
6256
+ "properties": {
6257
+ "total": {
6258
+ "type": {
6259
+ "scalar": "number"
6260
+ },
6261
+ "readonly": true,
6262
+ "optional": false
6263
+ },
6264
+ "citizenWallets": {
6265
+ "type": {
6266
+ "scalar": "number"
6267
+ },
6268
+ "readonly": true,
6269
+ "optional": false
6270
+ },
6271
+ "organisationWallets": {
6272
+ "type": {
6273
+ "scalar": "number"
6274
+ },
6275
+ "readonly": true,
6276
+ "optional": false
6277
+ },
6278
+ "founderWallets": {
6279
+ "type": {
6280
+ "scalar": "number"
6281
+ },
6282
+ "readonly": true,
6283
+ "optional": false
6284
+ },
6285
+ "createdInLast7Days": {
6286
+ "type": {
6287
+ "scalar": "number"
6288
+ },
6289
+ "readonly": true,
6290
+ "optional": false
6291
+ },
6292
+ "createdInLast30Days": {
6293
+ "type": {
6294
+ "scalar": "number"
6295
+ },
6296
+ "readonly": true,
6297
+ "optional": false
6298
+ }
6299
+ }
6300
+ },
5735
6301
  "QuickeningLadder": {
5736
6302
  "kind": "object",
5737
6303
  "properties": {
package/dist/errors.d.ts CHANGED
@@ -39,8 +39,10 @@
39
39
  * to the unions that own them, so neither can grow a member this union does not
40
40
  * carry. The founder claim's refusals are included the same way, and so are the
41
41
  * commercial payment's, the citizen market's, the marketplace status read's and the
42
- * two marketplace settlements', and the Percayso Cloud's two seams'.
42
+ * two marketplace settlements', the Percayso Cloud's two seams', and the binding of
43
+ * BizID's authority assertion to Percayso ID's.
43
44
  */
45
+ import type { AuthorityBindingRefusal } from './authority.js';
44
46
  import type { FounderClaimRefusal } from './citizenship.js';
45
47
  import type { BuyBackRefusal, QuotePlacementRefusal, QuoteWithdrawalRefusal } from './citizen-market.js';
46
48
  import type { SettlementAssertionRefusal, StandingAuthorisationRefusal, StandingAuthorisationRevocationRefusal, NodeBindingQueryRefusal, NodeBindingRefusal } from './cloud-settlement.js';
@@ -221,6 +223,15 @@ export type CaysoApiErrorCode =
221
223
  * are `marketplace_order_keys_not_configured`'s.
222
224
  */
223
225
  | 'contribution_store_issuer_not_configured'
226
+ /**
227
+ * No authority issuer is registered on this deployment, so no authority assertion
228
+ * from Percayso BizID is verified and no act that needs one is performed (CAY-0100).
229
+ * A closed door, never a refusal of the assertion and never "act as the Citizen
230
+ * alone". Declared before any route answers it: the binding to the identity
231
+ * assertion is the first to serve it. Not `authority_assertion_invalid`, which says
232
+ * the assertion was presented and refused.
233
+ */
234
+ | 'authority_issuer_not_configured'
224
235
  /**
225
236
  * No settlement store is wired — this deployment has no Treasury configured, so a
226
237
  * contribution has nowhere to be paid from and a consumption nowhere to be paid to
@@ -254,7 +265,7 @@ export type CaysoApiErrorCode =
254
265
  /** There is no such purchase under this caller's wallet. */
255
266
  | 'not_found'
256
267
  /** Something failed on the way and the refusal discloses nothing further. */
257
- | 'internal_error' | PurchaseFailureReason | PurchaseCancelRefusalReason | FounderClaimRefusal | CommercialPaymentRefusal | CitizenTransferRefusal | HandleChangeRefusal | HandleChangeReceiptReadRefusal | QuotePlacementRefusal | QuoteWithdrawalRefusal | BuyBackRefusal | MarketplaceReceiptReadRefusal | MarketplaceOrderRefusal | MarketplaceRefundRefusal | StandingAuthorisationRefusal | StandingAuthorisationRevocationRefusal | NodeBindingRefusal | NodeBindingQueryRefusal | SettlementAssertionRefusal;
268
+ | 'internal_error' | PurchaseFailureReason | PurchaseCancelRefusalReason | FounderClaimRefusal | CommercialPaymentRefusal | CitizenTransferRefusal | HandleChangeRefusal | HandleChangeReceiptReadRefusal | QuotePlacementRefusal | QuoteWithdrawalRefusal | BuyBackRefusal | MarketplaceReceiptReadRefusal | MarketplaceOrderRefusal | MarketplaceRefundRefusal | StandingAuthorisationRefusal | StandingAuthorisationRevocationRefusal | NodeBindingRefusal | NodeBindingQueryRefusal | SettlementAssertionRefusal | AuthorityBindingRefusal;
258
269
  /**
259
270
  * The body of every refusal on this surface: one code, and nothing beside it.
260
271
  *