@stridge/openapi 0.5.0 → 0.5.1

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 (4) hide show
  1. package/dist/openapi.dereferenced.json +229 -93
  2. package/dist/openapi.json +48 -29
  3. package/dist/types.d.ts +231 -65
  4. package/package.json +1 -1
package/dist/openapi.dereferenced.json CHANGED
@@ -171,6 +171,11 @@
171
171
  "type": "object",
172
172
  "description": "Resolved destination (symbol plus the resolved contract address).",
173
173
  "properties": {
174
+ "treasury": {
175
+ "type": "string",
176
+ "description": "The treasury name; present only for a treasury-backed destination.",
177
+ "example": "main"
178
+ },
174
179
  "address": {
175
180
  "type": "string",
176
181
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -293,6 +298,11 @@
293
298
  "destination": {
294
299
  "type": "object",
295
300
  "properties": {
301
+ "treasury": {
302
+ "type": "string",
303
+ "description": "The treasury name; present only for a treasury-backed destination.",
304
+ "example": "main"
305
+ },
296
306
  "address": {
297
307
  "type": "string",
298
308
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -641,7 +651,7 @@
641
651
  "UDA"
642
652
  ],
643
653
  "summary": "Create a UDA address",
644
- "description": "Allocate a new Universal Deposit Address for your tenant. If a UDA for the `(tenant, owner)` pair already exists, the existing record is returned with `200` instead of an error. `accepted_assets` is a list of asset symbols (e.g. `[\"USDC\", \"USDT\"]`); if empty, the UDA accepts every asset configured on every UDA-supported chain.\n",
654
+ "description": "Allocate a new Universal Deposit Address for your tenant. The call is idempotent on the owner and the destination together: if a UDA with the same `owner` and the same destination already exists, the existing record is returned with `200` instead of a duplicate. The destination is the treasury for a treasury-backed UDA, or the `(network_id, address, asset)` triple for an inline one; a treasury-backed UDA and an inline UDA are never collapsed into one, even when they point at the same wallet. The same owner with a different destination gets a new UDA. `accepted_assets` is a list of asset symbols (e.g. `[\"USDC\", \"USDT\"]`); if empty, the UDA accepts every asset configured on every UDA-supported chain.\n",
645
655
  "security": [
646
656
  {
647
657
  "ApiKeyAuth": []
@@ -674,28 +684,29 @@
674
684
  },
675
685
  "destination": {
676
686
  "type": "object",
677
- "description": "Where settlements for this UDA should be delivered.",
687
+ "description": "Where settlements for this UDA should be delivered, in exactly one of two forms: `treasury` (the name of one of your treasuries, so a rotation of the treasury moves the UDA with it), or inline `network_id` + `address` (+ `asset_symbol`), fixed at create time. Sending both forms is rejected with `400`.\n",
678
688
  "properties": {
689
+ "treasury": {
690
+ "type": "string",
691
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
692
+ "example": "main"
693
+ },
679
694
  "address": {
680
695
  "type": "string",
681
- "description": "Destination wallet address.",
696
+ "description": "Destination wallet address (inline form).",
682
697
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
683
698
  },
684
699
  "network_id": {
685
700
  "type": "string",
686
- "description": "Destination SLIP-44 network id.",
701
+ "description": "Destination SLIP-44 network id (inline form).",
687
702
  "example": "60"
688
703
  },
689
704
  "asset_symbol": {
690
705
  "type": "string",
691
- "description": "Destination asset symbol.",
706
+ "description": "Destination asset symbol (inline form).",
692
707
  "example": "USDC"
693
708
  }
694
- },
695
- "required": [
696
- "address",
697
- "network_id"
698
- ]
709
+ }
699
710
  },
700
711
  "accepted_assets": {
701
712
  "type": "array",
@@ -710,29 +721,35 @@
710
721
  },
711
722
  "routing_rules": {
712
723
  "type": "array",
724
+ "maxItems": 5,
713
725
  "items": {
714
726
  "type": "object",
715
727
  "properties": {
716
728
  "match": {
717
729
  "type": "object",
718
- "description": "Conditions a deposit must meet for this routing rule to apply.",
730
+ "description": "Conditions a deposit must meet for this routing rule to apply. At least one of the two fields is required: both pin one asset on one network, `source_network_id` alone matches any asset on that network, and `source_asset_symbol` alone matches that asset on any network. Two rules on one UDA may not share the same match.\n",
719
731
  "properties": {
720
732
  "source_network_id": {
721
733
  "type": "string",
734
+ "description": "Source SLIP-44 network id.",
722
735
  "example": "60"
723
736
  },
724
737
  "source_asset_symbol": {
725
738
  "type": "string",
739
+ "description": "Source asset symbol; must be one of the UDA's `accepted_assets` when that list is set.",
726
740
  "example": "USDT"
727
741
  }
728
- },
729
- "required": [
730
- "source_network_id"
731
- ]
742
+ }
732
743
  },
733
744
  "destination": {
734
745
  "type": "object",
746
+ "description": "Where a matching deposit settles, in the same two forms as the UDA's `destination`: a `treasury` name, or inline `network_id` + `address` (+ `asset_symbol`). Sending both forms is rejected with `400`.\n",
735
747
  "properties": {
748
+ "treasury": {
749
+ "type": "string",
750
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
751
+ "example": "main"
752
+ },
736
753
  "address": {
737
754
  "type": "string",
738
755
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -745,11 +762,7 @@
745
762
  "type": "string",
746
763
  "example": "USDC"
747
764
  }
748
- },
749
- "required": [
750
- "address",
751
- "network_id"
752
- ]
765
+ }
753
766
  }
754
767
  },
755
768
  "required": [
@@ -757,7 +770,7 @@
757
770
  "destination"
758
771
  ]
759
772
  },
760
- "description": "Optional; max 3. Specificity-wins precedence: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule. When nothing matches, settlements use the default destination.\n"
773
+ "description": "Optional; max 5. Specificity wins, whatever the order: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule, and either beats an asset-only rule. When no rule matches, the UDA's routing policy is consulted, and when that does not match either, settlements use the default destination.\n"
761
774
  },
762
775
  "routing_policy_id": {
763
776
  "type": "string",
@@ -787,7 +800,7 @@
787
800
  },
788
801
  "responses": {
789
802
  "200": {
790
- "description": "An existing UDA address for the `(tenant, owner)` pair was returned.",
803
+ "description": "An existing UDA address with the same `owner` and destination was returned.",
791
804
  "content": {
792
805
  "application/json": {
793
806
  "schema": {
@@ -823,6 +836,11 @@
823
836
  "type": "object",
824
837
  "description": "Resolved destination (symbol plus the resolved contract address).",
825
838
  "properties": {
839
+ "treasury": {
840
+ "type": "string",
841
+ "description": "The treasury name; present only for a treasury-backed destination.",
842
+ "example": "main"
843
+ },
826
844
  "address": {
827
845
  "type": "string",
828
846
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -945,6 +963,11 @@
945
963
  "destination": {
946
964
  "type": "object",
947
965
  "properties": {
966
+ "treasury": {
967
+ "type": "string",
968
+ "description": "The treasury name; present only for a treasury-backed destination.",
969
+ "example": "main"
970
+ },
948
971
  "address": {
949
972
  "type": "string",
950
973
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -1025,6 +1048,11 @@
1025
1048
  "type": "object",
1026
1049
  "description": "Resolved destination (symbol plus the resolved contract address).",
1027
1050
  "properties": {
1051
+ "treasury": {
1052
+ "type": "string",
1053
+ "description": "The treasury name; present only for a treasury-backed destination.",
1054
+ "example": "main"
1055
+ },
1028
1056
  "address": {
1029
1057
  "type": "string",
1030
1058
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -1147,6 +1175,11 @@
1147
1175
  "destination": {
1148
1176
  "type": "object",
1149
1177
  "properties": {
1178
+ "treasury": {
1179
+ "type": "string",
1180
+ "description": "The treasury name; present only for a treasury-backed destination.",
1181
+ "example": "main"
1182
+ },
1150
1183
  "address": {
1151
1184
  "type": "string",
1152
1185
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -2133,11 +2166,16 @@
2133
2166
  "type": "string",
2134
2167
  "enum": [
2135
2168
  "created",
2169
+ "refill_pending",
2170
+ "refill_confirmed",
2171
+ "awaiting_credit",
2136
2172
  "routing",
2173
+ "retrying",
2137
2174
  "completed",
2138
2175
  "failed",
2139
- "retrying"
2176
+ "refunded"
2140
2177
  ],
2178
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
2141
2179
  "example": "completed"
2142
2180
  },
2143
2181
  "created_at": {
@@ -2152,7 +2190,7 @@
2152
2190
  },
2153
2191
  "error": {
2154
2192
  "type": "string",
2155
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
2193
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
2156
2194
  "example": ""
2157
2195
  },
2158
2196
  "deposit": {
@@ -2233,6 +2271,7 @@
2233
2271
  },
2234
2272
  "fees": {
2235
2273
  "type": "object",
2274
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
2236
2275
  "properties": {
2237
2276
  "total": {
2238
2277
  "type": "string",
@@ -2624,11 +2663,16 @@
2624
2663
  "type": "string",
2625
2664
  "enum": [
2626
2665
  "created",
2666
+ "refill_pending",
2667
+ "refill_confirmed",
2668
+ "awaiting_credit",
2627
2669
  "routing",
2670
+ "retrying",
2628
2671
  "completed",
2629
2672
  "failed",
2630
- "retrying"
2673
+ "refunded"
2631
2674
  ],
2675
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
2632
2676
  "example": "completed"
2633
2677
  },
2634
2678
  "created_at": {
@@ -2643,7 +2687,7 @@
2643
2687
  },
2644
2688
  "error": {
2645
2689
  "type": "string",
2646
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
2690
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
2647
2691
  "example": ""
2648
2692
  },
2649
2693
  "deposit": {
@@ -2724,6 +2768,7 @@
2724
2768
  },
2725
2769
  "fees": {
2726
2770
  "type": "object",
2771
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
2727
2772
  "properties": {
2728
2773
  "total": {
2729
2774
  "type": "string",
@@ -3113,11 +3158,16 @@
3113
3158
  "type": "string",
3114
3159
  "enum": [
3115
3160
  "created",
3161
+ "refill_pending",
3162
+ "refill_confirmed",
3163
+ "awaiting_credit",
3116
3164
  "routing",
3165
+ "retrying",
3117
3166
  "completed",
3118
3167
  "failed",
3119
- "retrying"
3168
+ "refunded"
3120
3169
  ],
3170
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
3121
3171
  "example": "completed"
3122
3172
  },
3123
3173
  "created_at": {
@@ -3132,7 +3182,7 @@
3132
3182
  },
3133
3183
  "error": {
3134
3184
  "type": "string",
3135
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
3185
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
3136
3186
  "example": ""
3137
3187
  },
3138
3188
  "deposit": {
@@ -3213,6 +3263,7 @@
3213
3263
  },
3214
3264
  "fees": {
3215
3265
  "type": "object",
3266
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
3216
3267
  "properties": {
3217
3268
  "total": {
3218
3269
  "type": "string",
@@ -9372,6 +9423,11 @@
9372
9423
  "destination": {
9373
9424
  "type": "object",
9374
9425
  "properties": {
9426
+ "treasury": {
9427
+ "type": "string",
9428
+ "description": "The treasury name; present only for a treasury-backed destination.",
9429
+ "example": "main"
9430
+ },
9375
9431
  "address": {
9376
9432
  "type": "string",
9377
9433
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -9818,6 +9874,11 @@
9818
9874
  "destination": {
9819
9875
  "type": "object",
9820
9876
  "properties": {
9877
+ "treasury": {
9878
+ "type": "string",
9879
+ "description": "The treasury name; present only for a treasury-backed destination.",
9880
+ "example": "main"
9881
+ },
9821
9882
  "address": {
9822
9883
  "type": "string",
9823
9884
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -15370,8 +15431,8 @@
15370
15431
  },
15371
15432
  "version": {
15372
15433
  "type": "string",
15373
- "description": "The envelope format version.",
15374
- "example": "1"
15434
+ "description": "The event format version: `v1` for most events; payout, transfer and treasury events send `1.0.0`.",
15435
+ "example": "v1"
15375
15436
  },
15376
15437
  "type": {
15377
15438
  "type": "string",
@@ -15437,7 +15498,7 @@
15437
15498
  ],
15438
15499
  "example": {
15439
15500
  "id": "7401d9c7-e29d-4374-8952-af40f05168b7",
15440
- "version": "1",
15501
+ "version": "v1",
15441
15502
  "type": "uda.settlement.completed",
15442
15503
  "time": "2026-10-24T11:59:25Z",
15443
15504
  "livemode": false,
@@ -15445,8 +15506,8 @@
15445
15506
  "reset_epoch": 2,
15446
15507
  "payload": {
15447
15508
  "id": "stl_71829304a5b6c7d8",
15448
- "uda_id": "uda_2f8c1a9d4e5f6071",
15449
- "status": "completed"
15509
+ "uda_address_id": "uda_2f8c1a9d4e5f6071",
15510
+ "state": "completed"
15450
15511
  }
15451
15512
  }
15452
15513
  }
@@ -16492,8 +16553,8 @@
16492
16553
  },
16493
16554
  "version": {
16494
16555
  "type": "string",
16495
- "description": "The envelope format version.",
16496
- "example": "1"
16556
+ "description": "The event format version: `v1` for most events; payout, transfer and treasury events send `1.0.0`.",
16557
+ "example": "v1"
16497
16558
  },
16498
16559
  "type": {
16499
16560
  "type": "string",
@@ -16559,7 +16620,7 @@
16559
16620
  ],
16560
16621
  "example": {
16561
16622
  "id": "7401d9c7-e29d-4374-8952-af40f05168b7",
16562
- "version": "1",
16623
+ "version": "v1",
16563
16624
  "type": "uda.settlement.completed",
16564
16625
  "time": "2026-10-24T11:59:25Z",
16565
16626
  "livemode": false,
@@ -16567,8 +16628,8 @@
16567
16628
  "reset_epoch": 2,
16568
16629
  "payload": {
16569
16630
  "id": "stl_71829304a5b6c7d8",
16570
- "uda_id": "uda_2f8c1a9d4e5f6071",
16571
- "status": "completed"
16631
+ "uda_address_id": "uda_2f8c1a9d4e5f6071",
16632
+ "state": "completed"
16572
16633
  }
16573
16634
  }
16574
16635
  },
@@ -16638,49 +16699,55 @@
16638
16699
  },
16639
16700
  "DestinationInput": {
16640
16701
  "type": "object",
16641
- "description": "Where settlements for this UDA should be delivered.",
16702
+ "description": "Where settlements for this UDA should be delivered, in exactly one of two forms: `treasury` (the name of one of your treasuries, so a rotation of the treasury moves the UDA with it), or inline `network_id` + `address` (+ `asset_symbol`), fixed at create time. Sending both forms is rejected with `400`.\n",
16642
16703
  "properties": {
16704
+ "treasury": {
16705
+ "type": "string",
16706
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
16707
+ "example": "main"
16708
+ },
16643
16709
  "address": {
16644
16710
  "type": "string",
16645
- "description": "Destination wallet address.",
16711
+ "description": "Destination wallet address (inline form).",
16646
16712
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
16647
16713
  },
16648
16714
  "network_id": {
16649
16715
  "type": "string",
16650
- "description": "Destination SLIP-44 network id.",
16716
+ "description": "Destination SLIP-44 network id (inline form).",
16651
16717
  "example": "60"
16652
16718
  },
16653
16719
  "asset_symbol": {
16654
16720
  "type": "string",
16655
- "description": "Destination asset symbol.",
16721
+ "description": "Destination asset symbol (inline form).",
16656
16722
  "example": "USDC"
16657
16723
  }
16658
- },
16659
- "required": [
16660
- "address",
16661
- "network_id"
16662
- ]
16724
+ }
16663
16725
  },
16664
16726
  "RoutingRuleMatchInput": {
16665
16727
  "type": "object",
16666
- "description": "Conditions a deposit must meet for this routing rule to apply.",
16728
+ "description": "Conditions a deposit must meet for this routing rule to apply. At least one of the two fields is required: both pin one asset on one network, `source_network_id` alone matches any asset on that network, and `source_asset_symbol` alone matches that asset on any network. Two rules on one UDA may not share the same match.\n",
16667
16729
  "properties": {
16668
16730
  "source_network_id": {
16669
16731
  "type": "string",
16732
+ "description": "Source SLIP-44 network id.",
16670
16733
  "example": "60"
16671
16734
  },
16672
16735
  "source_asset_symbol": {
16673
16736
  "type": "string",
16737
+ "description": "Source asset symbol; must be one of the UDA's `accepted_assets` when that list is set.",
16674
16738
  "example": "USDT"
16675
16739
  }
16676
- },
16677
- "required": [
16678
- "source_network_id"
16679
- ]
16740
+ }
16680
16741
  },
16681
16742
  "RoutingRuleDestinationInput": {
16682
16743
  "type": "object",
16744
+ "description": "Where a matching deposit settles, in the same two forms as the UDA's `destination`: a `treasury` name, or inline `network_id` + `address` (+ `asset_symbol`). Sending both forms is rejected with `400`.\n",
16683
16745
  "properties": {
16746
+ "treasury": {
16747
+ "type": "string",
16748
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
16749
+ "example": "main"
16750
+ },
16684
16751
  "address": {
16685
16752
  "type": "string",
16686
16753
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -16693,35 +16760,36 @@
16693
16760
  "type": "string",
16694
16761
  "example": "USDC"
16695
16762
  }
16696
- },
16697
- "required": [
16698
- "address",
16699
- "network_id"
16700
- ]
16763
+ }
16701
16764
  },
16702
16765
  "RoutingRuleInput": {
16703
16766
  "type": "object",
16704
16767
  "properties": {
16705
16768
  "match": {
16706
16769
  "type": "object",
16707
- "description": "Conditions a deposit must meet for this routing rule to apply.",
16770
+ "description": "Conditions a deposit must meet for this routing rule to apply. At least one of the two fields is required: both pin one asset on one network, `source_network_id` alone matches any asset on that network, and `source_asset_symbol` alone matches that asset on any network. Two rules on one UDA may not share the same match.\n",
16708
16771
  "properties": {
16709
16772
  "source_network_id": {
16710
16773
  "type": "string",
16774
+ "description": "Source SLIP-44 network id.",
16711
16775
  "example": "60"
16712
16776
  },
16713
16777
  "source_asset_symbol": {
16714
16778
  "type": "string",
16779
+ "description": "Source asset symbol; must be one of the UDA's `accepted_assets` when that list is set.",
16715
16780
  "example": "USDT"
16716
16781
  }
16717
- },
16718
- "required": [
16719
- "source_network_id"
16720
- ]
16782
+ }
16721
16783
  },
16722
16784
  "destination": {
16723
16785
  "type": "object",
16786
+ "description": "Where a matching deposit settles, in the same two forms as the UDA's `destination`: a `treasury` name, or inline `network_id` + `address` (+ `asset_symbol`). Sending both forms is rejected with `400`.\n",
16724
16787
  "properties": {
16788
+ "treasury": {
16789
+ "type": "string",
16790
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
16791
+ "example": "main"
16792
+ },
16725
16793
  "address": {
16726
16794
  "type": "string",
16727
16795
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -16734,11 +16802,7 @@
16734
16802
  "type": "string",
16735
16803
  "example": "USDC"
16736
16804
  }
16737
- },
16738
- "required": [
16739
- "address",
16740
- "network_id"
16741
- ]
16805
+ }
16742
16806
  }
16743
16807
  },
16744
16808
  "required": [
@@ -16756,28 +16820,29 @@
16756
16820
  },
16757
16821
  "destination": {
16758
16822
  "type": "object",
16759
- "description": "Where settlements for this UDA should be delivered.",
16823
+ "description": "Where settlements for this UDA should be delivered, in exactly one of two forms: `treasury` (the name of one of your treasuries, so a rotation of the treasury moves the UDA with it), or inline `network_id` + `address` (+ `asset_symbol`), fixed at create time. Sending both forms is rejected with `400`.\n",
16760
16824
  "properties": {
16825
+ "treasury": {
16826
+ "type": "string",
16827
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
16828
+ "example": "main"
16829
+ },
16761
16830
  "address": {
16762
16831
  "type": "string",
16763
- "description": "Destination wallet address.",
16832
+ "description": "Destination wallet address (inline form).",
16764
16833
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
16765
16834
  },
16766
16835
  "network_id": {
16767
16836
  "type": "string",
16768
- "description": "Destination SLIP-44 network id.",
16837
+ "description": "Destination SLIP-44 network id (inline form).",
16769
16838
  "example": "60"
16770
16839
  },
16771
16840
  "asset_symbol": {
16772
16841
  "type": "string",
16773
- "description": "Destination asset symbol.",
16842
+ "description": "Destination asset symbol (inline form).",
16774
16843
  "example": "USDC"
16775
16844
  }
16776
- },
16777
- "required": [
16778
- "address",
16779
- "network_id"
16780
- ]
16845
+ }
16781
16846
  },
16782
16847
  "accepted_assets": {
16783
16848
  "type": "array",
@@ -16792,29 +16857,35 @@
16792
16857
  },
16793
16858
  "routing_rules": {
16794
16859
  "type": "array",
16860
+ "maxItems": 5,
16795
16861
  "items": {
16796
16862
  "type": "object",
16797
16863
  "properties": {
16798
16864
  "match": {
16799
16865
  "type": "object",
16800
- "description": "Conditions a deposit must meet for this routing rule to apply.",
16866
+ "description": "Conditions a deposit must meet for this routing rule to apply. At least one of the two fields is required: both pin one asset on one network, `source_network_id` alone matches any asset on that network, and `source_asset_symbol` alone matches that asset on any network. Two rules on one UDA may not share the same match.\n",
16801
16867
  "properties": {
16802
16868
  "source_network_id": {
16803
16869
  "type": "string",
16870
+ "description": "Source SLIP-44 network id.",
16804
16871
  "example": "60"
16805
16872
  },
16806
16873
  "source_asset_symbol": {
16807
16874
  "type": "string",
16875
+ "description": "Source asset symbol; must be one of the UDA's `accepted_assets` when that list is set.",
16808
16876
  "example": "USDT"
16809
16877
  }
16810
- },
16811
- "required": [
16812
- "source_network_id"
16813
- ]
16878
+ }
16814
16879
  },
16815
16880
  "destination": {
16816
16881
  "type": "object",
16882
+ "description": "Where a matching deposit settles, in the same two forms as the UDA's `destination`: a `treasury` name, or inline `network_id` + `address` (+ `asset_symbol`). Sending both forms is rejected with `400`.\n",
16817
16883
  "properties": {
16884
+ "treasury": {
16885
+ "type": "string",
16886
+ "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
16887
+ "example": "main"
16888
+ },
16818
16889
  "address": {
16819
16890
  "type": "string",
16820
16891
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -16827,11 +16898,7 @@
16827
16898
  "type": "string",
16828
16899
  "example": "USDC"
16829
16900
  }
16830
- },
16831
- "required": [
16832
- "address",
16833
- "network_id"
16834
- ]
16901
+ }
16835
16902
  }
16836
16903
  },
16837
16904
  "required": [
@@ -16839,7 +16906,7 @@
16839
16906
  "destination"
16840
16907
  ]
16841
16908
  },
16842
- "description": "Optional; max 3. Specificity-wins precedence: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule. When nothing matches, settlements use the default destination.\n"
16909
+ "description": "Optional; max 5. Specificity wins, whatever the order: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule, and either beats an asset-only rule. When no rule matches, the UDA's routing policy is consulted, and when that does not match either, settlements use the default destination.\n"
16843
16910
  },
16844
16911
  "routing_policy_id": {
16845
16912
  "type": "string",
@@ -16952,6 +17019,11 @@
16952
17019
  "type": "object",
16953
17020
  "description": "Resolved destination (symbol plus the resolved contract address).",
16954
17021
  "properties": {
17022
+ "treasury": {
17023
+ "type": "string",
17024
+ "description": "The treasury name; present only for a treasury-backed destination.",
17025
+ "example": "main"
17026
+ },
16955
17027
  "address": {
16956
17028
  "type": "string",
16957
17029
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17002,6 +17074,11 @@
17002
17074
  "RoutingRuleDestination": {
17003
17075
  "type": "object",
17004
17076
  "properties": {
17077
+ "treasury": {
17078
+ "type": "string",
17079
+ "description": "The treasury name; present only for a treasury-backed destination.",
17080
+ "example": "main"
17081
+ },
17005
17082
  "address": {
17006
17083
  "type": "string",
17007
17084
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17061,6 +17138,11 @@
17061
17138
  "destination": {
17062
17139
  "type": "object",
17063
17140
  "properties": {
17141
+ "treasury": {
17142
+ "type": "string",
17143
+ "description": "The treasury name; present only for a treasury-backed destination.",
17144
+ "example": "main"
17145
+ },
17064
17146
  "address": {
17065
17147
  "type": "string",
17066
17148
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17126,6 +17208,11 @@
17126
17208
  "type": "object",
17127
17209
  "description": "Resolved destination (symbol plus the resolved contract address).",
17128
17210
  "properties": {
17211
+ "treasury": {
17212
+ "type": "string",
17213
+ "description": "The treasury name; present only for a treasury-backed destination.",
17214
+ "example": "main"
17215
+ },
17129
17216
  "address": {
17130
17217
  "type": "string",
17131
17218
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17248,6 +17335,11 @@
17248
17335
  "destination": {
17249
17336
  "type": "object",
17250
17337
  "properties": {
17338
+ "treasury": {
17339
+ "type": "string",
17340
+ "description": "The treasury name; present only for a treasury-backed destination.",
17341
+ "example": "main"
17342
+ },
17251
17343
  "address": {
17252
17344
  "type": "string",
17253
17345
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17342,6 +17434,11 @@
17342
17434
  "destination": {
17343
17435
  "type": "object",
17344
17436
  "properties": {
17437
+ "treasury": {
17438
+ "type": "string",
17439
+ "description": "The treasury name; present only for a treasury-backed destination.",
17440
+ "example": "main"
17441
+ },
17345
17442
  "address": {
17346
17443
  "type": "string",
17347
17444
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17444,6 +17541,11 @@
17444
17541
  "destination": {
17445
17542
  "type": "object",
17446
17543
  "properties": {
17544
+ "treasury": {
17545
+ "type": "string",
17546
+ "description": "The treasury name; present only for a treasury-backed destination.",
17547
+ "example": "main"
17548
+ },
17447
17549
  "address": {
17448
17550
  "type": "string",
17449
17551
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17550,6 +17652,11 @@
17550
17652
  "destination": {
17551
17653
  "type": "object",
17552
17654
  "properties": {
17655
+ "treasury": {
17656
+ "type": "string",
17657
+ "description": "The treasury name; present only for a treasury-backed destination.",
17658
+ "example": "main"
17659
+ },
17553
17660
  "address": {
17554
17661
  "type": "string",
17555
17662
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17671,6 +17778,11 @@
17671
17778
  "type": "object",
17672
17779
  "description": "Resolved destination (symbol plus the resolved contract address).",
17673
17780
  "properties": {
17781
+ "treasury": {
17782
+ "type": "string",
17783
+ "description": "The treasury name; present only for a treasury-backed destination.",
17784
+ "example": "main"
17785
+ },
17674
17786
  "address": {
17675
17787
  "type": "string",
17676
17788
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -17793,6 +17905,11 @@
17793
17905
  "destination": {
17794
17906
  "type": "object",
17795
17907
  "properties": {
17908
+ "treasury": {
17909
+ "type": "string",
17910
+ "description": "The treasury name; present only for a treasury-backed destination.",
17911
+ "example": "main"
17912
+ },
17796
17913
  "address": {
17797
17914
  "type": "string",
17798
17915
  "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -18160,6 +18277,7 @@
18160
18277
  },
18161
18278
  "SettlementFees": {
18162
18279
  "type": "object",
18280
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
18163
18281
  "properties": {
18164
18282
  "total": {
18165
18283
  "type": "string",
@@ -18217,11 +18335,16 @@
18217
18335
  "type": "string",
18218
18336
  "enum": [
18219
18337
  "created",
18338
+ "refill_pending",
18339
+ "refill_confirmed",
18340
+ "awaiting_credit",
18220
18341
  "routing",
18342
+ "retrying",
18221
18343
  "completed",
18222
18344
  "failed",
18223
- "retrying"
18345
+ "refunded"
18224
18346
  ],
18347
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
18225
18348
  "example": "completed"
18226
18349
  },
18227
18350
  "created_at": {
@@ -18236,7 +18359,7 @@
18236
18359
  },
18237
18360
  "error": {
18238
18361
  "type": "string",
18239
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
18362
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
18240
18363
  "example": ""
18241
18364
  },
18242
18365
  "deposit": {
@@ -18317,6 +18440,7 @@
18317
18440
  },
18318
18441
  "fees": {
18319
18442
  "type": "object",
18443
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
18320
18444
  "properties": {
18321
18445
  "total": {
18322
18446
  "type": "string",
@@ -18386,11 +18510,16 @@
18386
18510
  "type": "string",
18387
18511
  "enum": [
18388
18512
  "created",
18513
+ "refill_pending",
18514
+ "refill_confirmed",
18515
+ "awaiting_credit",
18389
18516
  "routing",
18517
+ "retrying",
18390
18518
  "completed",
18391
18519
  "failed",
18392
- "retrying"
18520
+ "refunded"
18393
18521
  ],
18522
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
18394
18523
  "example": "completed"
18395
18524
  },
18396
18525
  "created_at": {
@@ -18405,7 +18534,7 @@
18405
18534
  },
18406
18535
  "error": {
18407
18536
  "type": "string",
18408
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
18537
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
18409
18538
  "example": ""
18410
18539
  },
18411
18540
  "deposit": {
@@ -18486,6 +18615,7 @@
18486
18615
  },
18487
18616
  "fees": {
18488
18617
  "type": "object",
18618
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
18489
18619
  "properties": {
18490
18620
  "total": {
18491
18621
  "type": "string",
@@ -18585,11 +18715,16 @@
18585
18715
  "type": "string",
18586
18716
  "enum": [
18587
18717
  "created",
18718
+ "refill_pending",
18719
+ "refill_confirmed",
18720
+ "awaiting_credit",
18588
18721
  "routing",
18722
+ "retrying",
18589
18723
  "completed",
18590
18724
  "failed",
18591
- "retrying"
18725
+ "refunded"
18592
18726
  ],
18727
+ "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
18593
18728
  "example": "completed"
18594
18729
  },
18595
18730
  "created_at": {
@@ -18604,7 +18739,7 @@
18604
18739
  },
18605
18740
  "error": {
18606
18741
  "type": "string",
18607
- "description": "Failure reason when `status` is `failed`; empty otherwise.",
18742
+ "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
18608
18743
  "example": ""
18609
18744
  },
18610
18745
  "deposit": {
@@ -18685,6 +18820,7 @@
18685
18820
  },
18686
18821
  "fees": {
18687
18822
  "type": "object",
18823
+ "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
18688
18824
  "properties": {
18689
18825
  "total": {
18690
18826
  "type": "string",