@percayso-community/cayso-contracts 0.29.0 → 0.30.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 (17) hide show
  1. package/README.md +38 -14
  2. package/dist/assertion.d.ts +12 -2
  3. package/dist/assurance.js +37 -0
  4. package/dist/client.d.ts +24 -3
  5. package/dist/client.js +18 -0
  6. package/dist/cloud-settlement.d.ts +336 -20
  7. package/dist/contract-schema.generated.js +490 -2
  8. package/dist/errors.d.ts +55 -2
  9. package/dist/index.d.ts +72 -2
  10. package/dist/index.js +71 -1
  11. package/dist/operator.d.ts +6 -1
  12. package/dist/operator.js +2 -0
  13. package/dist/routes.d.ts +68 -3
  14. package/dist/routes.js +65 -3
  15. package/dist/schema-types.d.ts +12 -2
  16. package/dist/schema.d.ts +20 -8
  17. 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.29.0",
17
+ "contractVersion": "0.30.0",
18
18
  "packageName": "@percayso-community/cayso-contracts",
19
19
  "capabilities": {
20
20
  "wallet": "cayso.wallet",
@@ -93,6 +93,14 @@ export const CONTRACT_SCHEMA = {
93
93
  "method": "POST",
94
94
  "path": "/api/cloud/standing-authorisations"
95
95
  },
96
+ "revokeStandingAuthorisation": {
97
+ "method": "POST",
98
+ "path": "/api/cloud/standing-authorisation-revocations"
99
+ },
100
+ "bindNode": {
101
+ "method": "POST",
102
+ "path": "/api/cloud/node-bindings"
103
+ },
96
104
  "version": {
97
105
  "method": "GET",
98
106
  "path": "/api/version"
@@ -102,9 +110,87 @@ export const CONTRACT_SCHEMA = {
102
110
  "cloudSettlement": {
103
111
  "method": "POST",
104
112
  "path": "/api/cloud/settlement-assertions"
113
+ },
114
+ "nodeBindingQuery": {
115
+ "method": "POST",
116
+ "path": "/api/cloud/node-binding-queries"
117
+ }
118
+ },
119
+ "keyRoutes": {
120
+ "acknowledgementKeys": {
121
+ "method": "GET",
122
+ "path": "/api/acknowledgement-keys"
105
123
  }
106
124
  },
107
125
  "types": {
126
+ "AcknowledgementKeyId": {
127
+ "kind": "alias",
128
+ "of": {
129
+ "scalar": "string"
130
+ }
131
+ },
132
+ "AcknowledgementKeySet": {
133
+ "kind": "object",
134
+ "properties": {
135
+ "keys": {
136
+ "type": {
137
+ "array": {
138
+ "ref": "AcknowledgementPublicKey"
139
+ },
140
+ "readonly": true
141
+ },
142
+ "readonly": true,
143
+ "optional": false
144
+ }
145
+ }
146
+ },
147
+ "AcknowledgementPublicKey": {
148
+ "kind": "object",
149
+ "properties": {
150
+ "kty": {
151
+ "type": {
152
+ "literal": "OKP"
153
+ },
154
+ "readonly": true,
155
+ "optional": false
156
+ },
157
+ "crv": {
158
+ "type": {
159
+ "literal": "Ed25519"
160
+ },
161
+ "readonly": true,
162
+ "optional": false
163
+ },
164
+ "x": {
165
+ "type": {
166
+ "scalar": "string"
167
+ },
168
+ "readonly": true,
169
+ "optional": false
170
+ },
171
+ "kid": {
172
+ "type": {
173
+ "ref": "AcknowledgementKeyId"
174
+ },
175
+ "readonly": true,
176
+ "optional": false
177
+ },
178
+ "alg": {
179
+ "type": {
180
+ "literal": "EdDSA"
181
+ },
182
+ "readonly": true,
183
+ "optional": false
184
+ },
185
+ "use": {
186
+ "type": {
187
+ "literal": "sig"
188
+ },
189
+ "readonly": true,
190
+ "optional": false
191
+ }
192
+ }
193
+ },
108
194
  "Allowance": {
109
195
  "kind": "object",
110
196
  "properties": {
@@ -697,6 +783,30 @@ export const CONTRACT_SCHEMA = {
697
783
  {
698
784
  "literal": "receipt_signing_not_configured"
699
785
  },
786
+ {
787
+ "literal": "acknowledgement_signing_not_configured"
788
+ },
789
+ {
790
+ "literal": "standing_authorisation_store_not_configured"
791
+ },
792
+ {
793
+ "literal": "standing_authorisation_cap_ceiling_not_configured"
794
+ },
795
+ {
796
+ "literal": "standing_authorisation_life_ceiling_not_configured"
797
+ },
798
+ {
799
+ "literal": "node_binding_store_not_configured"
800
+ },
801
+ {
802
+ "literal": "core_node_ids_not_configured"
803
+ },
804
+ {
805
+ "literal": "contribution_store_issuer_not_configured"
806
+ },
807
+ {
808
+ "literal": "cloud_settlement_store_not_configured"
809
+ },
700
810
  {
701
811
  "literal": "marketplace_order_keys_not_configured"
702
812
  },
@@ -757,6 +867,15 @@ export const CONTRACT_SCHEMA = {
757
867
  {
758
868
  "ref": "StandingAuthorisationRefusal"
759
869
  },
870
+ {
871
+ "ref": "StandingAuthorisationRevocationRefusal"
872
+ },
873
+ {
874
+ "ref": "NodeBindingRefusal"
875
+ },
876
+ {
877
+ "ref": "NodeBindingQueryRefusal"
878
+ },
760
879
  {
761
880
  "ref": "SettlementAssertionRefusal"
762
881
  }
@@ -1453,11 +1572,17 @@ export const CONTRACT_SCHEMA = {
1453
1572
  {
1454
1573
  "literal": "consumption_authorisation_revoked"
1455
1574
  },
1575
+ {
1576
+ "literal": "consumption_authorisation_not_in_force"
1577
+ },
1456
1578
  {
1457
1579
  "literal": "consumption_cap_not_the_acknowledged_cap"
1458
1580
  },
1459
1581
  {
1460
1582
  "literal": "consumption_over_cap"
1583
+ },
1584
+ {
1585
+ "literal": "consumption_wallet_short"
1461
1586
  }
1462
1587
  ]
1463
1588
  }
@@ -1558,6 +1683,12 @@ export const CONTRACT_SCHEMA = {
1558
1683
  },
1559
1684
  {
1560
1685
  "literal": "present-standing-authorisation"
1686
+ },
1687
+ {
1688
+ "literal": "revoke-standing-authorisation"
1689
+ },
1690
+ {
1691
+ "literal": "bind-node"
1561
1692
  }
1562
1693
  ]
1563
1694
  }
@@ -1651,7 +1782,17 @@ export const CONTRACT_SCHEMA = {
1651
1782
  "ContributionRowRefusal": {
1652
1783
  "kind": "alias",
1653
1784
  "of": {
1654
- "literal": "contribution_node_not_bound"
1785
+ "union": [
1786
+ {
1787
+ "literal": "contribution_node_not_bound"
1788
+ },
1789
+ {
1790
+ "literal": "contribution_node_is_a_core_node"
1791
+ },
1792
+ {
1793
+ "literal": "contribution_treasury_short"
1794
+ }
1795
+ ]
1655
1796
  }
1656
1797
  },
1657
1798
  "ContributionRowRefused": {
@@ -2750,12 +2891,265 @@ export const CONTRACT_SCHEMA = {
2750
2891
  "scalar": "number"
2751
2892
  }
2752
2893
  },
2894
+ "NodeBindingQueryClaims": {
2895
+ "kind": "object",
2896
+ "properties": {
2897
+ "iss": {
2898
+ "type": {
2899
+ "ref": "ContributionStoreIssuer"
2900
+ },
2901
+ "readonly": true,
2902
+ "optional": false
2903
+ },
2904
+ "aud": {
2905
+ "type": {
2906
+ "literal": "cayso"
2907
+ },
2908
+ "readonly": true,
2909
+ "optional": false
2910
+ },
2911
+ "node_id": {
2912
+ "type": {
2913
+ "ref": "NodeId"
2914
+ },
2915
+ "readonly": true,
2916
+ "optional": false
2917
+ },
2918
+ "iat": {
2919
+ "type": {
2920
+ "scalar": "number"
2921
+ },
2922
+ "readonly": true,
2923
+ "optional": false
2924
+ },
2925
+ "exp": {
2926
+ "type": {
2927
+ "scalar": "number"
2928
+ },
2929
+ "readonly": true,
2930
+ "optional": false
2931
+ }
2932
+ }
2933
+ },
2934
+ "NodeBindingQueryRefusal": {
2935
+ "kind": "alias",
2936
+ "of": {
2937
+ "union": [
2938
+ {
2939
+ "literal": "node_binding_query_malformed"
2940
+ },
2941
+ {
2942
+ "literal": "node_binding_query_issuer_not_recognised"
2943
+ },
2944
+ {
2945
+ "literal": "node_binding_query_issuer_for_another_environment"
2946
+ },
2947
+ {
2948
+ "literal": "node_binding_query_signature_invalid"
2949
+ },
2950
+ {
2951
+ "literal": "node_binding_query_not_current"
2952
+ }
2953
+ ]
2954
+ }
2955
+ },
2956
+ "NodeBindingQueryRefused": {
2957
+ "kind": "object",
2958
+ "properties": {
2959
+ "outcome": {
2960
+ "type": {
2961
+ "literal": "refused"
2962
+ },
2963
+ "readonly": true,
2964
+ "optional": false
2965
+ },
2966
+ "error": {
2967
+ "type": {
2968
+ "ref": "NodeBindingQueryRefusal"
2969
+ },
2970
+ "readonly": true,
2971
+ "optional": false
2972
+ }
2973
+ }
2974
+ },
2975
+ "NodeBindingQueryRequest": {
2976
+ "kind": "object",
2977
+ "properties": {
2978
+ "nodeBindingQuery": {
2979
+ "type": {
2980
+ "scalar": "string"
2981
+ },
2982
+ "readonly": true,
2983
+ "optional": false
2984
+ }
2985
+ }
2986
+ },
2987
+ "NodeBindingRefusal": {
2988
+ "kind": "alias",
2989
+ "of": {
2990
+ "union": [
2991
+ {
2992
+ "literal": "assurance_not_money_grade"
2993
+ },
2994
+ {
2995
+ "literal": "node_presentation_malformed"
2996
+ },
2997
+ {
2998
+ "literal": "instance_key_malformed"
2999
+ },
3000
+ {
3001
+ "literal": "node_presentation_not_signed_by_its_instance_key"
3002
+ },
3003
+ {
3004
+ "literal": "node_presentation_not_current"
3005
+ },
3006
+ {
3007
+ "literal": "instance_key_not_bound_to_holder"
3008
+ },
3009
+ {
3010
+ "literal": "core_node_not_bound"
3011
+ },
3012
+ {
3013
+ "literal": "node_bound_to_another_wallet"
3014
+ }
3015
+ ]
3016
+ }
3017
+ },
3018
+ "NodeBindingRefused": {
3019
+ "kind": "object",
3020
+ "properties": {
3021
+ "outcome": {
3022
+ "type": {
3023
+ "literal": "refused"
3024
+ },
3025
+ "readonly": true,
3026
+ "optional": false
3027
+ },
3028
+ "error": {
3029
+ "type": {
3030
+ "ref": "NodeBindingRefusal"
3031
+ },
3032
+ "readonly": true,
3033
+ "optional": false
3034
+ }
3035
+ }
3036
+ },
3037
+ "NodeBindingRequest": {
3038
+ "kind": "object",
3039
+ "properties": {
3040
+ "nodePresentation": {
3041
+ "type": {
3042
+ "scalar": "string"
3043
+ },
3044
+ "readonly": true,
3045
+ "optional": false
3046
+ },
3047
+ "instanceKey": {
3048
+ "type": {
3049
+ "scalar": "string"
3050
+ },
3051
+ "readonly": true,
3052
+ "optional": false
3053
+ }
3054
+ }
3055
+ },
3056
+ "NodeBindingResponse": {
3057
+ "kind": "alias",
3058
+ "of": {
3059
+ "union": [
3060
+ {
3061
+ "ref": "NodeBound"
3062
+ },
3063
+ {
3064
+ "ref": "NodeBindingRefused"
3065
+ }
3066
+ ]
3067
+ }
3068
+ },
3069
+ "NodeBindingStatus": {
3070
+ "kind": "object",
3071
+ "properties": {
3072
+ "nodeId": {
3073
+ "type": {
3074
+ "ref": "NodeId"
3075
+ },
3076
+ "readonly": true,
3077
+ "optional": false
3078
+ },
3079
+ "bound": {
3080
+ "type": {
3081
+ "scalar": "boolean"
3082
+ },
3083
+ "readonly": true,
3084
+ "optional": false
3085
+ }
3086
+ }
3087
+ },
3088
+ "NodeBound": {
3089
+ "kind": "object",
3090
+ "properties": {
3091
+ "outcome": {
3092
+ "type": {
3093
+ "literal": "bound"
3094
+ },
3095
+ "readonly": true,
3096
+ "optional": false
3097
+ },
3098
+ "nodeId": {
3099
+ "type": {
3100
+ "ref": "NodeId"
3101
+ },
3102
+ "readonly": true,
3103
+ "optional": false
3104
+ }
3105
+ }
3106
+ },
2753
3107
  "NodeId": {
2754
3108
  "kind": "alias",
2755
3109
  "of": {
2756
3110
  "scalar": "string"
2757
3111
  }
2758
3112
  },
3113
+ "NodePresentationClaims": {
3114
+ "kind": "object",
3115
+ "properties": {
3116
+ "iss": {
3117
+ "type": {
3118
+ "ref": "InstanceKeyId"
3119
+ },
3120
+ "readonly": true,
3121
+ "optional": false
3122
+ },
3123
+ "aud": {
3124
+ "type": {
3125
+ "literal": "cayso"
3126
+ },
3127
+ "readonly": true,
3128
+ "optional": false
3129
+ },
3130
+ "node_id": {
3131
+ "type": {
3132
+ "ref": "NodeId"
3133
+ },
3134
+ "readonly": true,
3135
+ "optional": false
3136
+ },
3137
+ "iat": {
3138
+ "type": {
3139
+ "scalar": "number"
3140
+ },
3141
+ "readonly": true,
3142
+ "optional": false
3143
+ },
3144
+ "exp": {
3145
+ "type": {
3146
+ "scalar": "number"
3147
+ },
3148
+ "readonly": true,
3149
+ "optional": false
3150
+ }
3151
+ }
3152
+ },
2759
3153
  "OrganisationView": {
2760
3154
  "kind": "object",
2761
3155
  "properties": {
@@ -3806,11 +4200,20 @@ export const CONTRACT_SCHEMA = {
3806
4200
  {
3807
4201
  "literal": "settlement_jti_not_the_period"
3808
4202
  },
4203
+ {
4204
+ "literal": "settlement_period_not_recognised"
4205
+ },
4206
+ {
4207
+ "literal": "settlement_period_not_ended"
4208
+ },
3809
4209
  {
3810
4210
  "literal": "settlement_period_already_settled_differently"
3811
4211
  },
3812
4212
  {
3813
4213
  "literal": "settlement_totals_do_not_add"
4214
+ },
4215
+ {
4216
+ "literal": "settlement_carve_contended"
3814
4217
  }
3815
4218
  ]
3816
4219
  }
@@ -4216,6 +4619,85 @@ export const CONTRACT_SCHEMA = {
4216
4619
  ]
4217
4620
  }
4218
4621
  },
4622
+ "StandingAuthorisationRevocationRefusal": {
4623
+ "kind": "alias",
4624
+ "of": {
4625
+ "union": [
4626
+ {
4627
+ "literal": "assurance_not_money_grade"
4628
+ },
4629
+ {
4630
+ "literal": "wallet_has_no_live_binding"
4631
+ },
4632
+ {
4633
+ "literal": "authorisation_not_held_by_this_wallet"
4634
+ }
4635
+ ]
4636
+ }
4637
+ },
4638
+ "StandingAuthorisationRevocationRefused": {
4639
+ "kind": "object",
4640
+ "properties": {
4641
+ "outcome": {
4642
+ "type": {
4643
+ "literal": "refused"
4644
+ },
4645
+ "readonly": true,
4646
+ "optional": false
4647
+ },
4648
+ "error": {
4649
+ "type": {
4650
+ "ref": "StandingAuthorisationRevocationRefusal"
4651
+ },
4652
+ "readonly": true,
4653
+ "optional": false
4654
+ }
4655
+ }
4656
+ },
4657
+ "StandingAuthorisationRevocationRequest": {
4658
+ "kind": "object",
4659
+ "properties": {
4660
+ "authorisation": {
4661
+ "type": {
4662
+ "scalar": "string"
4663
+ },
4664
+ "readonly": true,
4665
+ "optional": false
4666
+ }
4667
+ }
4668
+ },
4669
+ "StandingAuthorisationRevocationResponse": {
4670
+ "kind": "alias",
4671
+ "of": {
4672
+ "union": [
4673
+ {
4674
+ "ref": "StandingAuthorisationRevoked"
4675
+ },
4676
+ {
4677
+ "ref": "StandingAuthorisationRevocationRefused"
4678
+ }
4679
+ ]
4680
+ }
4681
+ },
4682
+ "StandingAuthorisationRevoked": {
4683
+ "kind": "object",
4684
+ "properties": {
4685
+ "outcome": {
4686
+ "type": {
4687
+ "literal": "revoked"
4688
+ },
4689
+ "readonly": true,
4690
+ "optional": false
4691
+ },
4692
+ "authorisation": {
4693
+ "type": {
4694
+ "scalar": "string"
4695
+ },
4696
+ "readonly": true,
4697
+ "optional": false
4698
+ }
4699
+ }
4700
+ },
4219
4701
  "StoreSignedStatement": {
4220
4702
  "kind": "object",
4221
4703
  "properties": {
@@ -4511,6 +4993,12 @@ export const CONTRACT_SCHEMA = {
4511
4993
  },
4512
4994
  {
4513
4995
  "literal": "marketplace_settlement"
4996
+ },
4997
+ {
4998
+ "literal": "contribution_settlement"
4999
+ },
5000
+ {
5001
+ "literal": "consumption_settlement"
4514
5002
  }
4515
5003
  ]
4516
5004
  }
package/dist/errors.d.ts CHANGED
@@ -43,7 +43,7 @@
43
43
  */
44
44
  import type { FounderClaimRefusal } from './citizenship.js';
45
45
  import type { BuyBackRefusal, QuotePlacementRefusal, QuoteWithdrawalRefusal } from './citizen-market.js';
46
- import type { SettlementAssertionRefusal, StandingAuthorisationRefusal } from './cloud-settlement.js';
46
+ import type { SettlementAssertionRefusal, StandingAuthorisationRefusal, StandingAuthorisationRevocationRefusal, NodeBindingQueryRefusal, NodeBindingRefusal } from './cloud-settlement.js';
47
47
  import type { CitizenTransferRefusal } from './citizen-transfer.js';
48
48
  import type { HandleChangeReceiptReadRefusal, HandleChangeRefusal } from './handle-change.js';
49
49
  import type { CommercialPaymentRefusal } from './commercial-payment.js';
@@ -175,6 +175,59 @@ export type CaysoApiErrorCode =
175
175
  * start.
176
176
  */
177
177
  | 'receipt_signing_not_configured'
178
+ /**
179
+ * This deployment holds no key it may sign an authorisation acknowledgement with,
180
+ * so it publishes no acknowledgement key and signs no acknowledgement (CAY-0093).
181
+ * A closed door, never an empty key set: a verifier reading an empty set would
182
+ * learn nothing true.
183
+ */
184
+ | 'acknowledgement_signing_not_configured'
185
+ /**
186
+ * No standing-authorisation store is wired, so no Instance key can be bound and no
187
+ * authorisation presented or revoked (CAY-0094).
188
+ */
189
+ | 'standing_authorisation_store_not_configured'
190
+ /**
191
+ * The ceiling on what a holder may delegate to an Instance per period is not
192
+ * configured on this deployment, so no standing authorisation is acknowledged
193
+ * (CAY-0094, CAY-0024). The figure is the canon's; unset is a closed door and never
194
+ * "no limit", and it is not `cap_not_delegable`, which says the cap is too high.
195
+ */
196
+ | 'standing_authorisation_cap_ceiling_not_configured'
197
+ /**
198
+ * The ceiling on how long a standing authorisation may live is not configured on
199
+ * this deployment, so none is acknowledged (CAY-0094). The figure is the canon's;
200
+ * unset is a closed door and never "no limit", and it is not
201
+ * `authorisation_outlives_its_ceiling`, which says the authorisation is too long.
202
+ */
203
+ | 'standing_authorisation_life_ceiling_not_configured'
204
+ /**
205
+ * No Node-binding store is wired, so no Node can be bound and the Contribution
206
+ * Store's read of a Node's binding is not answered (CAY-0095). Never "unbound": a
207
+ * read that cannot look must not tell the Store a bound Node's rows are withheld.
208
+ */
209
+ | 'node_binding_store_not_configured'
210
+ /**
211
+ * This deployment has not been told which Node IDs are Core Nodes, so no Node is
212
+ * bound and the Store's read is not answered (CAY-0095): binding one, or answering for
213
+ * one, without knowing would let a Core Node, whose owner is the Operator, earn for a
214
+ * Citizen Wallet. Told "none" is a configuration; untold is a closed door.
215
+ */
216
+ | 'core_node_ids_not_configured'
217
+ /**
218
+ * No Contribution Store issuer is registered on this deployment, so no statement
219
+ * from the Store is verified and the Store's read of a Node's binding is not
220
+ * answered (CAY-0095). Not Store Platform's order keys, which
221
+ * are `marketplace_order_keys_not_configured`'s.
222
+ */
223
+ | 'contribution_store_issuer_not_configured'
224
+ /**
225
+ * No settlement store is wired — this deployment has no Treasury configured, so a
226
+ * contribution has nowhere to be paid from and a consumption nowhere to be paid to
227
+ * — and no settlement assertion is settled (CAY-0096). Never a refusal: the Store's
228
+ * period is not wrong, Cayso is not ready to read it.
229
+ */
230
+ | 'cloud_settlement_store_not_configured'
178
231
  /**
179
232
  * This deployment holds no registry of Store Platform order keys, so no signed
180
233
  * order can be verified and no marketplace operation is served (CAY-0083 §4).
@@ -201,7 +254,7 @@ export type CaysoApiErrorCode =
201
254
  /** There is no such purchase under this caller's wallet. */
202
255
  | 'not_found'
203
256
  /** Something failed on the way and the refusal discloses nothing further. */
204
- | 'internal_error' | PurchaseFailureReason | PurchaseCancelRefusalReason | FounderClaimRefusal | CommercialPaymentRefusal | CitizenTransferRefusal | HandleChangeRefusal | HandleChangeReceiptReadRefusal | QuotePlacementRefusal | QuoteWithdrawalRefusal | BuyBackRefusal | MarketplaceReceiptReadRefusal | MarketplaceOrderRefusal | MarketplaceRefundRefusal | StandingAuthorisationRefusal | SettlementAssertionRefusal;
257
+ | 'internal_error' | PurchaseFailureReason | PurchaseCancelRefusalReason | FounderClaimRefusal | CommercialPaymentRefusal | CitizenTransferRefusal | HandleChangeRefusal | HandleChangeReceiptReadRefusal | QuotePlacementRefusal | QuoteWithdrawalRefusal | BuyBackRefusal | MarketplaceReceiptReadRefusal | MarketplaceOrderRefusal | MarketplaceRefundRefusal | StandingAuthorisationRefusal | StandingAuthorisationRevocationRefusal | NodeBindingRefusal | NodeBindingQueryRefusal | SettlementAssertionRefusal;
205
258
  /**
206
259
  * The body of every refusal on this surface: one code, and nothing beside it.
207
260
  *