@hyperscale0/hsx 1.0.0 → 1.0.123

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 (316) hide show
  1. package/CHANGELOG.md +5 -256
  2. package/LICENSE.md +356 -0
  3. package/NOTICE.md +8 -0
  4. package/README.md +44 -44
  5. package/bin/hsx.ts +0 -7
  6. package/dist/bin/hsx.d.ts +0 -4
  7. package/dist/bin/hsx.d.ts.map +1 -1
  8. package/dist/bin/hsx.js +0 -6
  9. package/dist/bin/hsx.js.map +1 -1
  10. package/dist/src/ast.d.ts +113 -308
  11. package/dist/src/ast.d.ts.map +1 -1
  12. package/dist/src/ast.js +7 -71
  13. package/dist/src/ast.js.map +1 -1
  14. package/dist/src/attachment-economics.d.ts +5 -0
  15. package/dist/src/attachment-economics.d.ts.map +1 -0
  16. package/dist/src/attachment-economics.js +55 -0
  17. package/dist/src/attachment-economics.js.map +1 -0
  18. package/dist/src/binding-contract.d.ts +22 -0
  19. package/dist/src/binding-contract.d.ts.map +1 -0
  20. package/dist/src/binding-contract.js +74 -0
  21. package/dist/src/binding-contract.js.map +1 -0
  22. package/dist/src/cli.d.ts +4 -19
  23. package/dist/src/cli.d.ts.map +1 -1
  24. package/dist/src/cli.js +89 -276
  25. package/dist/src/cli.js.map +1 -1
  26. package/dist/src/compile.d.ts +34 -66
  27. package/dist/src/compile.d.ts.map +1 -1
  28. package/dist/src/compile.js +2949 -117
  29. package/dist/src/compile.js.map +1 -1
  30. package/dist/src/cost.d.ts +8 -75
  31. package/dist/src/cost.d.ts.map +1 -1
  32. package/dist/src/cost.js +54 -364
  33. package/dist/src/cost.js.map +1 -1
  34. package/dist/src/diagnostics.d.ts +14 -9
  35. package/dist/src/diagnostics.d.ts.map +1 -1
  36. package/dist/src/diagnostics.js +39 -416
  37. package/dist/src/diagnostics.js.map +1 -1
  38. package/dist/src/examples-bundle.d.ts +3 -0
  39. package/dist/src/examples-bundle.d.ts.map +1 -0
  40. package/dist/src/examples-bundle.js +18 -0
  41. package/dist/src/examples-bundle.js.map +1 -0
  42. package/dist/src/examples.d.ts +10 -0
  43. package/dist/src/examples.d.ts.map +1 -0
  44. package/dist/src/examples.js +2 -0
  45. package/dist/src/examples.js.map +1 -0
  46. package/dist/src/format.d.ts +8 -7
  47. package/dist/src/format.d.ts.map +1 -1
  48. package/dist/src/format.js +9 -175
  49. package/dist/src/format.js.map +1 -1
  50. package/dist/src/header-source.d.ts +3 -0
  51. package/dist/src/header-source.d.ts.map +1 -0
  52. package/dist/src/header-source.js +41 -0
  53. package/dist/src/header-source.js.map +1 -0
  54. package/dist/src/headers.d.ts +64 -0
  55. package/dist/src/headers.d.ts.map +1 -0
  56. package/dist/src/headers.js +167 -0
  57. package/dist/src/headers.js.map +1 -0
  58. package/dist/src/index.d.ts +7 -11
  59. package/dist/src/index.d.ts.map +1 -1
  60. package/dist/src/index.js +4 -9
  61. package/dist/src/index.js.map +1 -1
  62. package/dist/src/keywords.d.ts +56 -0
  63. package/dist/src/keywords.d.ts.map +1 -0
  64. package/dist/src/keywords.js +133 -0
  65. package/dist/src/keywords.js.map +1 -0
  66. package/dist/src/language.d.ts +26 -0
  67. package/dist/src/language.d.ts.map +1 -0
  68. package/dist/src/language.js +440 -0
  69. package/dist/src/language.js.map +1 -0
  70. package/dist/src/lex.d.ts +13 -28
  71. package/dist/src/lex.d.ts.map +1 -1
  72. package/dist/src/lex.js +119 -145
  73. package/dist/src/lex.js.map +1 -1
  74. package/dist/src/parse.d.ts +4 -17
  75. package/dist/src/parse.d.ts.map +1 -1
  76. package/dist/src/parse.js +484 -1036
  77. package/dist/src/parse.js.map +1 -1
  78. package/dist/src/std-bundle.d.ts.map +1 -1
  79. package/dist/src/std-bundle.js +11 -84
  80. package/dist/src/std-bundle.js.map +1 -1
  81. package/dist/src/std-library.d.ts +1 -1
  82. package/dist/src/std-library.d.ts.map +1 -1
  83. package/dist/src/std-library.js +1 -5
  84. package/dist/src/std-library.js.map +1 -1
  85. package/dist/src/tunables.d.ts +7 -0
  86. package/dist/src/tunables.d.ts.map +1 -0
  87. package/dist/src/tunables.js +27 -0
  88. package/dist/src/tunables.js.map +1 -0
  89. package/docs/README.md +528 -26
  90. package/docs/assets/brand/hsx-horizontal-white.svg +1 -0
  91. package/docs/assets/brand/hsx-horizontal.svg +1 -0
  92. package/docs/assets/brand/hsx-stacked-white.svg +1 -0
  93. package/docs/assets/brand/hsx-stacked.svg +1 -0
  94. package/docs/assets/brand/manifest.json +30 -0
  95. package/docs/assets/hsx.svg +11 -0
  96. package/examples/cards.hsx +34 -0
  97. package/examples/collections.hsx +37 -0
  98. package/examples/cost-table.json +633 -385
  99. package/examples/escrow.hsx +24 -0
  100. package/examples/financing.hsx +32 -0
  101. package/examples/insurance.hsx +30 -0
  102. package/examples/lending.hsx +57 -0
  103. package/examples/library.hsx +15 -0
  104. package/examples/marketplace.hsx +32 -0
  105. package/examples/money.hsx +19 -0
  106. package/examples/rental-deposit.hsx +60 -0
  107. package/examples/repair-approval.hsx +44 -0
  108. package/examples/reporting.hsx +28 -0
  109. package/examples/savings.hsx +21 -0
  110. package/examples/serviced.hsx +25 -0
  111. package/examples/wallet.hsx +24 -0
  112. package/package.json +25 -23
  113. package/src/ast.ts +83 -440
  114. package/src/attachment-economics.ts +103 -0
  115. package/src/binding-contract.ts +104 -0
  116. package/src/cli.ts +95 -325
  117. package/src/compile.ts +4063 -209
  118. package/src/cost.ts +71 -574
  119. package/src/diagnostics.ts +57 -437
  120. package/src/examples-bundle.ts +19 -0
  121. package/src/examples.ts +9 -0
  122. package/src/format.ts +12 -256
  123. package/src/header-source.ts +54 -0
  124. package/src/headers.ts +195 -0
  125. package/src/index.ts +18 -33
  126. package/src/keywords.ts +134 -0
  127. package/src/language.ts +629 -0
  128. package/src/lex.ts +131 -192
  129. package/src/parse.ts +489 -1195
  130. package/src/std-bundle.ts +12 -88
  131. package/src/std-library.ts +2 -7
  132. package/src/tunables.ts +36 -0
  133. package/std/cards.hsx +85 -0
  134. package/std/collections.hsx +90 -0
  135. package/std/escrow.hsx +73 -0
  136. package/std/financing.hsx +683 -0
  137. package/std/insurance.hsx +89 -0
  138. package/std/lending.hsx +138 -0
  139. package/std/marketplace.hsx +123 -0
  140. package/std/money.hsx +173 -0
  141. package/std/reporting.hsx +753 -0
  142. package/std/savings.hsx +68 -0
  143. package/std/wallet.hsx +57 -0
  144. package/LICENSE +0 -661
  145. package/LICENSING.md +0 -52
  146. package/TRADEMARKS.md +0 -35
  147. package/dist/src/emit.d.ts +0 -34
  148. package/dist/src/emit.d.ts.map +0 -1
  149. package/dist/src/emit.js +0 -137
  150. package/dist/src/emit.js.map +0 -1
  151. package/dist/src/entry-overrides.d.ts +0 -58
  152. package/dist/src/entry-overrides.d.ts.map +0 -1
  153. package/dist/src/entry-overrides.js +0 -284
  154. package/dist/src/entry-overrides.js.map +0 -1
  155. package/dist/src/ir.d.ts +0 -66
  156. package/dist/src/ir.d.ts.map +0 -1
  157. package/dist/src/ir.js +0 -15
  158. package/dist/src/ir.js.map +0 -1
  159. package/dist/src/limits.d.ts +0 -21
  160. package/dist/src/limits.d.ts.map +0 -1
  161. package/dist/src/limits.js +0 -21
  162. package/dist/src/limits.js.map +0 -1
  163. package/dist/src/lsp/server.d.ts +0 -32
  164. package/dist/src/lsp/server.d.ts.map +0 -1
  165. package/dist/src/lsp/server.js +0 -391
  166. package/dist/src/lsp/server.js.map +0 -1
  167. package/dist/src/modules.d.ts +0 -38
  168. package/dist/src/modules.d.ts.map +0 -1
  169. package/dist/src/modules.js +0 -368
  170. package/dist/src/modules.js.map +0 -1
  171. package/dist/src/typecheck.d.ts +0 -8
  172. package/dist/src/typecheck.d.ts.map +0 -1
  173. package/dist/src/typecheck.js +0 -2958
  174. package/dist/src/typecheck.js.map +0 -1
  175. package/dist/src/version.d.ts +0 -5
  176. package/dist/src/version.d.ts.map +0 -1
  177. package/dist/src/version.js +0 -5
  178. package/dist/src/version.js.map +0 -1
  179. package/docs/guide/01-first-program.md +0 -24
  180. package/docs/guide/02-money.md +0 -25
  181. package/docs/guide/03-instruments.md +0 -22
  182. package/docs/guide/04-lifecycles.md +0 -25
  183. package/docs/guide/05-fees-and-splits.md +0 -45
  184. package/docs/guide/06-schedules.md +0 -22
  185. package/docs/guide/07-composition.md +0 -46
  186. package/docs/guide/08-writing-a-module.md +0 -26
  187. package/docs/guide/09-cost.md +0 -24
  188. package/docs/guide/10-diagnostics.md +0 -27
  189. package/docs/llms-full.txt +0 -1739
  190. package/docs/llms.txt +0 -45
  191. package/docs/playground.md +0 -54
  192. package/docs/reference/cli.md +0 -35
  193. package/docs/reference/diagnostics.md +0 -619
  194. package/docs/reference/grammar.md +0 -39
  195. package/docs/reference/std/advance.md +0 -35
  196. package/docs/reference/std/cancellable_booking.md +0 -35
  197. package/docs/reference/std/captured_payment.md +0 -43
  198. package/docs/reference/std/conditional_disbursement.md +0 -33
  199. package/docs/reference/std/credit_facility.md +0 -35
  200. package/docs/reference/std/held_payment.md +0 -64
  201. package/docs/reference/std/instant_transfer.md +0 -30
  202. package/docs/reference/std/metered.md +0 -27
  203. package/docs/reference/std/pooled_split.md +0 -26
  204. package/docs/reference/std/premium_forward.md +0 -39
  205. package/docs/reference/std/reconciled_payout.md +0 -33
  206. package/docs/reference/std/recurring_collection.md +0 -25
  207. package/docs/reference/std/rotating_pool.md +0 -42
  208. package/docs/reference/std/scheduled.md +0 -51
  209. package/docs/reference/std/security_deposit.md +0 -46
  210. package/docs/reference/std/settlement_batch.md +0 -42
  211. package/docs/reference/std/swap.md +0 -46
  212. package/docs/reference/std/threshold_pool.md +0 -47
  213. package/docs/reference/std/weighted_distribution.md +0 -39
  214. package/docs/reference/types.md +0 -20
  215. package/docs/reference/udl-output.md +0 -13
  216. package/docs/sessions/2026-09-02-two-instruments.hsx +0 -21
  217. package/docs/sessions/2026-09-02-two-instruments.md +0 -41
  218. package/examples/01-first-program/README.md +0 -45
  219. package/examples/01-first-program/tip-jar.hsx +0 -17
  220. package/examples/02-imports-and-archetypes/README.md +0 -96
  221. package/examples/02-imports-and-archetypes/photo-booth.hsx +0 -37
  222. package/examples/03-diagnostics/README.md +0 -68
  223. package/examples/03-diagnostics/corner-shop-fixed.hsx +0 -22
  224. package/examples/03-diagnostics/corner-shop.hsx +0 -19
  225. package/examples/04-complete-product/README.md +0 -84
  226. package/examples/04-complete-product/study-hall.hsx +0 -67
  227. package/examples/05-watch-club/README.md +0 -9
  228. package/examples/05-watch-club/watch-club.hsx +0 -124
  229. package/examples/README.md +0 -18
  230. package/examples/advance/README.md +0 -3
  231. package/examples/advance/advance.hsx +0 -13
  232. package/examples/advance/advance.udl +0 -339
  233. package/examples/cancellable_booking/README.md +0 -3
  234. package/examples/cancellable_booking/cancellable_booking.hsx +0 -14
  235. package/examples/cancellable_booking/cancellable_booking.udl +0 -391
  236. package/examples/captured_payment/README.md +0 -3
  237. package/examples/captured_payment/captured_payment.hsx +0 -21
  238. package/examples/captured_payment/captured_payment.udl +0 -677
  239. package/examples/conditional_disbursement/README.md +0 -3
  240. package/examples/conditional_disbursement/conditional_disbursement.hsx +0 -17
  241. package/examples/conditional_disbursement/conditional_disbursement.udl +0 -412
  242. package/examples/credit_facility/README.md +0 -3
  243. package/examples/credit_facility/credit_facility.hsx +0 -27
  244. package/examples/credit_facility/credit_facility.udl +0 -1373
  245. package/examples/held_payment/README.md +0 -3
  246. package/examples/held_payment/held_payment.hsx +0 -13
  247. package/examples/held_payment/held_payment.udl +0 -507
  248. package/examples/instant_transfer/README.md +0 -3
  249. package/examples/instant_transfer/instant_transfer.hsx +0 -16
  250. package/examples/instant_transfer/instant_transfer.udl +0 -364
  251. package/examples/metered/README.md +0 -3
  252. package/examples/metered/metered.hsx +0 -13
  253. package/examples/metered/metered.udl +0 -247
  254. package/examples/pooled_split/README.md +0 -3
  255. package/examples/pooled_split/pooled_split.hsx +0 -15
  256. package/examples/pooled_split/pooled_split.udl +0 -425
  257. package/examples/premium_forward/README.md +0 -3
  258. package/examples/premium_forward/premium_forward.hsx +0 -19
  259. package/examples/premium_forward/premium_forward.udl +0 -594
  260. package/examples/reconciled_payout/README.md +0 -3
  261. package/examples/reconciled_payout/reconciled_payout.hsx +0 -13
  262. package/examples/reconciled_payout/reconciled_payout.udl +0 -303
  263. package/examples/recurring_collection/README.md +0 -3
  264. package/examples/recurring_collection/recurring_collection.hsx +0 -21
  265. package/examples/recurring_collection/recurring_collection.udl +0 -1130
  266. package/examples/rotating_pool/README.md +0 -3
  267. package/examples/rotating_pool/rotating_pool.hsx +0 -18
  268. package/examples/rotating_pool/rotating_pool.udl +0 -4352
  269. package/examples/scheduled/README.md +0 -3
  270. package/examples/scheduled/scheduled.hsx +0 -12
  271. package/examples/scheduled/scheduled.udl +0 -335
  272. package/examples/security_deposit/README.md +0 -3
  273. package/examples/security_deposit/security_deposit.hsx +0 -21
  274. package/examples/security_deposit/security_deposit.udl +0 -293
  275. package/examples/settlement_batch/README.md +0 -3
  276. package/examples/settlement_batch/settlement_batch.hsx +0 -19
  277. package/examples/settlement_batch/settlement_batch.udl +0 -753
  278. package/examples/swap/README.md +0 -3
  279. package/examples/swap/swap.hsx +0 -19
  280. package/examples/swap/swap.udl +0 -876
  281. package/examples/threshold_pool/README.md +0 -3
  282. package/examples/threshold_pool/threshold_pool.hsx +0 -16
  283. package/examples/threshold_pool/threshold_pool.udl +0 -667
  284. package/examples/weighted_distribution/README.md +0 -3
  285. package/examples/weighted_distribution/weighted_distribution.hsx +0 -20
  286. package/examples/weighted_distribution/weighted_distribution.udl +0 -337
  287. package/skills/hsx/SKILL.md +0 -483
  288. package/src/emit.ts +0 -201
  289. package/src/entry-overrides.ts +0 -428
  290. package/src/ir.ts +0 -99
  291. package/src/limits.ts +0 -20
  292. package/src/lsp/server.ts +0 -460
  293. package/src/modules.ts +0 -446
  294. package/src/typecheck.ts +0 -3876
  295. package/src/version.ts +0 -5
  296. package/std/SEMANTICS.md +0 -130
  297. package/std/settlements/advance.hsx +0 -177
  298. package/std/settlements/cancellable_booking.hsx +0 -87
  299. package/std/settlements/captured_payment.hsx +0 -144
  300. package/std/settlements/conditional_disbursement.hsx +0 -185
  301. package/std/settlements/credit_facility.hsx +0 -167
  302. package/std/settlements/held_payment.hsx +0 -578
  303. package/std/settlements/index.hsx +0 -3
  304. package/std/settlements/instant_transfer.hsx +0 -190
  305. package/std/settlements/metered.hsx +0 -67
  306. package/std/settlements/pooled_split.hsx +0 -68
  307. package/std/settlements/premium_forward.hsx +0 -257
  308. package/std/settlements/reconciled_payout.hsx +0 -77
  309. package/std/settlements/recurring_collection.hsx +0 -27
  310. package/std/settlements/rotating_pool.hsx +0 -252
  311. package/std/settlements/scheduled.hsx +0 -641
  312. package/std/settlements/security_deposit.hsx +0 -166
  313. package/std/settlements/settlement_batch.hsx +0 -122
  314. package/std/settlements/swap.hsx +0 -1114
  315. package/std/settlements/threshold_pool.hsx +0 -221
  316. package/std/settlements/weighted_distribution.hsx +0 -141
package/docs/reference/std/cancellable_booking.md DELETED
@@ -1,35 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # cancellable_booking
4
-
5
- Source: [`std/settlements/cancellable_booking.hsx`](../../../std/settlements/cancellable_booking.hsx)
6
-
7
- ## Export
8
-
9
- `cancellable_booking<C>`
10
-
11
- ## Parameters
12
-
13
- - `guest: party`
14
- - `host: party`
15
- - `amount: money<C>`
16
- - `starts_at: date`
17
- - `late_penalty_bps: integer`
18
- - `late_within: text`
19
- - `early_penalty_bps: integer`
20
- - `offer_life: text`
21
-
22
- ## Decision ports
23
-
24
- None.
25
-
26
- ## Actions and clauses
27
-
28
- | Action | Clauses lowered |
29
- | ---------- | ---------------------------------------------------------- |
30
- | `create` | `agent description`, `moves`, `steps`, `summary` |
31
- | `take` | `agent description`, `moves`, `steps`, `summary` |
32
- | `complete` | `due`, `moves`, `steps`, `summary` |
33
- | `cancel` | `agent description`, `moves`, `quote`, `steps`, `summary` |
34
- | `confirm` | `agent description`, `commit`, `moves`, `steps`, `summary` |
35
- | `retain` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/captured_payment.md DELETED
@@ -1,43 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # captured_payment
4
-
5
- Source: [`std/settlements/captured_payment.hsx`](../../../std/settlements/captured_payment.hsx)
6
-
7
- ## Export
8
-
9
- `captured_payment<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `payee: party`
15
- - `amount: money<C>`
16
- - `reserve_until: date`
17
- - `correction: condition`
18
- - `external_reversal: condition`
19
- - `capture_mode: text`
20
- - `correction_mode: text`
21
- - `negative_position: text`
22
- - `timeout: text`
23
- - `derived_amount: optional<block>`
24
-
25
- ## Decision ports
26
-
27
- - `correction`
28
- - `external_reversal`
29
-
30
- ## Actions and clauses
31
-
32
- | Action | Clauses lowered |
33
- | ------------------ | -------------------------------------------------------------------------------------------- |
34
- | `create` | `agent description`, `moves`, `steps`, `summary` |
35
- | `authorize` | `agent description`, `moves`, `steps`, `summary` |
36
- | `capture` | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary` |
37
- | `capture_more` | `agent description`, `deadline`, `description`, `input`, `moves`, `steps`, `summary` |
38
- | `settle` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
39
- | `void` | `agent description`, `moves`, `steps`, `summary` |
40
- | `expire` | `due`, `moves`, `steps`, `summary` |
41
- | `settle_on_expiry` | `due`, `moves`, `steps`, `summary` |
42
- | `correction_name` | `agent description`, `moves`, `port`, `steps`, `summary` |
43
- | `reversal_name` | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
package/docs/reference/std/conditional_disbursement.md DELETED
@@ -1,33 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # conditional_disbursement
4
-
5
- Source: [`std/settlements/conditional_disbursement.hsx`](../../../std/settlements/conditional_disbursement.hsx)
6
-
7
- ## Export
8
-
9
- `conditional_disbursement<C>`
10
-
11
- ## Parameters
12
-
13
- - `source: party`
14
- - `destination: party`
15
- - `cap: money<C>`
16
- - `amount: money<C>`
17
- - `decision: condition`
18
- - `reopen_policy: text`
19
- - `recovery_policy: text`
20
-
21
- ## Decision ports
22
-
23
- - `decision`
24
-
25
- ## Actions and clauses
26
-
27
- | Action | Clauses lowered |
28
- | --------- | ------------------------------------------------------------------------------------------------- |
29
- | `create` | `agent description`, `moves`, `steps`, `summary` |
30
- | `deny` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
31
- | `create` | `agent description`, `moves`, `steps`, `summary` |
32
- | `approve` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
33
- | `pay` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/credit_facility.md DELETED
@@ -1,35 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # credit_facility
4
-
5
- Source: [`std/settlements/credit_facility.hsx`](../../../std/settlements/credit_facility.hsx)
6
-
7
- ## Export
8
-
9
- `credit_facility<C>`
10
-
11
- ## Parameters
12
-
13
- - `lender: party`
14
- - `borrower: party`
15
- - `draw_destination: party`
16
- - `limit: money<C>`
17
- - `expires_at: date`
18
- - `obligation: ref`
19
- - `availability_policy: text`
20
- - `expiry_policy: text`
21
- - `close_policy: text`
22
-
23
- ## Decision ports
24
-
25
- None.
26
-
27
- ## Actions and clauses
28
-
29
- | Action | Clauses lowered |
30
- | --------- | ------------------------------------------------ |
31
- | `create` | `agent description`, `moves`, `steps`, `summary` |
32
- | `freeze` | `due`, `moves`, `steps`, `summary` |
33
- | `close` | `agent description`, `moves`, `steps`, `summary` |
34
- | `create` | `agent description`, `moves`, `steps`, `summary` |
35
- | `resolve` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/held_payment.md DELETED
@@ -1,64 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # held_payment
4
-
5
- Source: [`std/settlements/held_payment.hsx`](../../../std/settlements/held_payment.hsx)
6
-
7
- ## Export
8
-
9
- `held_payment<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `payee: party`
15
- - `amount: money<C>`
16
- - `release: condition`
17
- - `fees: optional<block>`
18
- - `on_cancel: optional<block>`
19
- - `derived_amount: optional<block>`
20
- - `release_to: optional<party>`
21
- - `whole_amount: optional<block>`
22
- - `release_action: optional<text>`
23
- - `whole_fee: optional<money<C>>`
24
- - `reference: optional<text>`
25
- - `upstream: optional<ref>`
26
- - `id_prefix_override: optional<text>`
27
-
28
- ## Decision ports
29
-
30
- - `release`
31
-
32
- ## Actions and clauses
33
-
34
- | Action | Clauses lowered |
35
- | --------------------- | --------------------------------------------------------------------------------------------- |
36
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
37
- | `fund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
38
- | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
39
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
40
- | `release_piece_3` | `agent description`, `moves`, `steps`, `summary` |
41
- | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
42
- | `refund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
43
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
44
- | `unfund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
45
- | `unfund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
46
- | `create` | `agent description`, `moves`, `steps`, `summary` |
47
- | `fund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
48
- | `release_name` | `agent description`, `deadline`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
49
- | `release_on_deadline` | `due`, `moves`, `steps`, `summary` |
50
- | `cancel` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
51
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
52
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
53
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
54
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
55
- | `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
56
- | `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
57
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
58
- | `abandon` | `agent description`, `moves`, `steps`, `summary` |
59
- | `create` | `agent description`, `moves`, `steps`, `summary` |
60
- | `fund` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
61
- | `release_action` | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
62
- | `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary` |
63
- | `cancel` | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary` |
64
- | `abandon` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/instant_transfer.md DELETED
@@ -1,30 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # instant_transfer
4
-
5
- Source: [`std/settlements/instant_transfer.hsx`](../../../std/settlements/instant_transfer.hsx)
6
-
7
- ## Export
8
-
9
- `instant_transfer<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `payee: party`
15
- - `amount: money<C>`
16
- - `fees: optional<block>`
17
- - `derived_amount: optional<block>`
18
-
19
- ## Decision ports
20
-
21
- None.
22
-
23
- ## Actions and clauses
24
-
25
- | Action | Clauses lowered |
26
- | --------------------- | ------------------------------------------------ |
27
- | `create` | `agent description`, `moves`, `steps`, `summary` |
28
- | `pay_piece_1` | `agent description`, `moves`, `steps`, `summary` |
29
- | `pay_piece_2` | `agent description`, `moves`, `steps`, `summary` |
30
- | `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/metered.md DELETED
@@ -1,27 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # metered
4
-
5
- Source: [`std/settlements/metered.hsx`](../../../std/settlements/metered.hsx)
6
-
7
- ## Export
8
-
9
- `metered`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `payee: party`
15
- - `close_by: date`
16
- - `rates: unknown`
17
-
18
- ## Decision ports
19
-
20
- None.
21
-
22
- ## Actions and clauses
23
-
24
- | Action | Clauses lowered |
25
- | -------------- | --------------------------------------- |
26
- | `create` | `agent description`, `steps`, `summary` |
27
- | `close_period` | `due`, `steps`, `summary` |
package/docs/reference/std/pooled_split.md DELETED
@@ -1,26 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # pooled_split
4
-
5
- Source: [`std/settlements/pooled_split.hsx`](../../../std/settlements/pooled_split.hsx)
6
-
7
- ## Export
8
-
9
- `pooled_split<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `amount: money<C>`
15
- - `payout_due: date`
16
- - `split: block`
17
-
18
- ## Decision ports
19
-
20
- None.
21
-
22
- ## Actions and clauses
23
-
24
- | Action | Clauses lowered |
25
- | -------- | ------------------------------------------------ |
26
- | `create` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/premium_forward.md DELETED
@@ -1,39 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # premium_forward
4
-
5
- Source: [`std/settlements/premium_forward.hsx`](../../../std/settlements/premium_forward.hsx)
6
-
7
- ## Export
8
-
9
- `premium_forward<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `carrier: party`
15
- - `amount: money<C>`
16
- - `bind: condition`
17
- - `commission: percent`
18
- - `policy_ref: optional<text>`
19
- - `renewal_due: optional<date>`
20
- - `endorsement: optional<condition>`
21
-
22
- ## Decision ports
23
-
24
- - `bind`
25
- - `endorsement`
26
-
27
- ## Actions and clauses
28
-
29
- | Action | Clauses lowered |
30
- | ----------------- | ---------------------------------------------------------------------------------------- |
31
- | `create` | `agent description`, `steps`, `summary` |
32
- | `fund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
33
- | `fund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
34
- | `bind` | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
35
- | `forward_piece_2` | `agent description`, `moves`, `steps`, `summary` |
36
- | `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
37
- | `abandon` | `agent description`, `steps`, `summary` |
38
- | `endorsement` | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary` |
39
- | `lapse` | `due`, `steps`, `summary` |
package/docs/reference/std/reconciled_payout.md DELETED
@@ -1,33 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # reconciled_payout
4
-
5
- Source: [`std/settlements/reconciled_payout.hsx`](../../../std/settlements/reconciled_payout.hsx)
6
-
7
- ## Export
8
-
9
- `reconciled_payout<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `beneficiary: party`
15
- - `amount: money<C>`
16
- - `beneficiary_ref: text`
17
- - `settle_by: date`
18
- - `matched_within: integer`
19
- - `matched_ceiling: integer`
20
-
21
- ## Decision ports
22
-
23
- None.
24
-
25
- ## Actions and clauses
26
-
27
- | Action | Clauses lowered |
28
- | ---------- | ---------------------------------------------------------- |
29
- | `create` | `agent description`, `moves`, `steps`, `summary` |
30
- | `instruct` | `agent description`, `moves`, `payout`, `steps`, `summary` |
31
- | `settle` | `due`, `moves`, `reconcile`, `steps`, `summary` |
32
- | `create` | `agent description`, `moves`, `steps`, `summary` |
33
- | `carry` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/recurring_collection.md DELETED
@@ -1,25 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # recurring_collection
4
-
5
- Source: [`std/settlements/recurring_collection.hsx`](../../../std/settlements/recurring_collection.hsx)
6
-
7
- ## Export
8
-
9
- `recurring_collection`
10
-
11
- ## Parameters
12
-
13
- - `marker: optional<text>`
14
-
15
- ## Decision ports
16
-
17
- None.
18
-
19
- ## Actions and clauses
20
-
21
- | Action | Clauses lowered |
22
- | --------- | --------------------------------------- |
23
- | `create` | `agent description`, `steps`, `summary` |
24
- | `collect` | `agent description`, `steps`, `summary` |
25
- | `end` | `agent description`, `steps`, `summary` |
package/docs/reference/std/rotating_pool.md DELETED
@@ -1,42 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # rotating_pool
4
-
5
- Source: [`std/settlements/rotating_pool.hsx`](../../../std/settlements/rotating_pool.hsx)
6
-
7
- ## Export
8
-
9
- `rotating_pool<C>`
10
-
11
- ## Parameters
12
-
13
- - `members: optional<list<party>>`
14
- - `contribution: money<C>`
15
- - `count: integer`
16
- - `every: optional<text>`
17
- - `first_due: date`
18
- - `payout_order: optional<list<party>>`
19
- - `default_policy: optional<text>`
20
- - `guarantee_policy: optional<text>`
21
- - `guarantor: optional<party>`
22
- - `exit_policy: optional<text>`
23
- - `memo: optional<text>`
24
- - `membership: optional<block>`
25
-
26
- ## Decision ports
27
-
28
- None.
29
-
30
- ## Actions and clauses
31
-
32
- | Action | Clauses lowered |
33
- | ---------- | ------------------------------------------------- |
34
- | `create` | `agent description`, `moves`, `steps`, `summary` |
35
- | `cancel` | `agent description`, `moves`, `steps`, `summary` |
36
- | `activate` | `agent description`, `moves`, `steps`, `summary` |
37
- | `create` | `agent description`, `moves`, `steps`, `summary` |
38
- | `close` | `agent description`, `moves`, `steps`, `summary` |
39
- | `create` | `agent description`, `examples`, `moves`, `steps` |
40
- | `activate` | `due`, `examples`, `moves`, `steps` |
41
- | `disband` | `agent description`, `examples`, `moves`, `steps` |
42
- | `close` | `agent description`, `examples`, `moves`, `steps` |
package/docs/reference/std/scheduled.md DELETED
@@ -1,51 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # scheduled
4
-
5
- Source: [`std/settlements/scheduled.hsx`](../../../std/settlements/scheduled.hsx)
6
-
7
- ## Export
8
-
9
- `scheduled<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `payee: party`
15
- - `amount: money<C>`
16
- - `count: optional<integer>`
17
- - `every: text`
18
- - `first_due: date`
19
- - `mode: optional<text>`
20
- - `debtor: optional<party>`
21
- - `advance_to: optional<party>`
22
- - `until: optional<condition>`
23
- - `month_end: optional<text>`
24
- - `period_liability: optional<text>`
25
- - `termination_drain: optional<text>`
26
- - `mandate: optional<condition>`
27
- - `derived_amount: optional<unknown>`
28
-
29
- ## Decision ports
30
-
31
- - `until`
32
- - `mandate`
33
-
34
- ## Actions and clauses
35
-
36
- | Action | Clauses lowered |
37
- | ------------------- | ------------------------------------------------------------------------------------------------- |
38
- | `create` | `agent description`, `steps`, `summary` |
39
- | `create` | `agent description`, `moves`, `steps`, `summary` |
40
- | `approve` | `agent description`, `steps`, `summary` |
41
- | `advance` | `agent description`, `moves`, `steps`, `summary` |
42
- | `delinquent_action` | `due`, `sets at`, `steps`, `summary` |
43
- | `complete` | `due`, `steps`, `summary` |
44
- | `write_off` | `agent description`, `steps`, `summary` |
45
- | `create` | `agent description`, `steps`, `summary` |
46
- | `repay` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
47
- | `refund` | `agent description`, `moves`, `steps`, `summary` |
48
- | `create` | `agent description`, `steps`, `summary` |
49
- | `open_period` | `due`, `steps`, `summary` |
50
- | `collect_period` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
51
- | `until` | `agent description`, `capture input`, `description`, `input`, `port`, `steps`, `summary` |
package/docs/reference/std/security_deposit.md DELETED
@@ -1,46 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # security_deposit
4
-
5
- Source: [`std/settlements/security_deposit.hsx`](../../../std/settlements/security_deposit.hsx)
6
-
7
- ## Export
8
-
9
- `security_deposit<C>`
10
-
11
- ## Parameters
12
-
13
- - `payer: party`
14
- - `holder: party`
15
- - `amount: money<C>`
16
- - `claim: optional<condition>`
17
- - `return: optional<condition>`
18
- - `claim_amount: optional<block>`
19
- - `deadline: optional<date>`
20
- - `claim_to: optional<party>`
21
- - `return_to: optional<party>`
22
- - `memo: optional<text>`
23
- - `claim_input: optional<block>`
24
- - `claim_capture: optional<block>`
25
- - `fund_failure_point: optional<text>`
26
- - `id_prefix_override: optional<text>`
27
-
28
- ## Decision ports
29
-
30
- - `claim`
31
- - `return`
32
-
33
- ## Actions and clauses
34
-
35
- | Action | Clauses lowered |
36
- | --------------- | ---------------------------------------------------------------------------------------------------------------- |
37
- | `create` | `agent description`, `moves`, `steps`, `summary` |
38
- | `place_deposit` | `agent description`, `moves`, `steps`, `summary` |
39
- | `claim_name` | `agent description`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
40
- | `return_name` | `agent description`, `moves`, `steps`, `summary` |
41
- | `create` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
42
- | `fund` | `agent description`, `deadline`, `moves`, `sandbox failure point`, `steps`, `summary` |
43
- | `claim` | `agent description`, `capture input`, `deadline`, `decided amount`, `input`, `moves`, `port`, `steps`, `summary` |
44
- | `return` | `agent description`, `deadline`, `moves`, `port`, `steps`, `summary` |
45
- | `expire` | `due`, `moves`, `steps`, `summary` |
46
- | `cancel` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/settlement_batch.md DELETED
@@ -1,42 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # settlement_batch
4
-
5
- Source: [`std/settlements/settlement_batch.hsx`](../../../std/settlements/settlement_batch.hsx)
6
-
7
- ## Export
8
-
9
- `settlement_batch<C>`
10
-
11
- ## Parameters
12
-
13
- - `settlement_account: party`
14
- - `source_capture_refs: text`
15
- - `fee_entries: text`
16
- - `external_reversal_offsets: text`
17
- - `close_trigger: date`
18
- - `payout_destination: party`
19
- - `negative_position: text`
20
- - `payout_acknowledgement: condition`
21
- - `payout_beneficiary_ref: text`
22
-
23
- ## Decision ports
24
-
25
- - `payout_acknowledgement`
26
-
27
- ## Actions and clauses
28
-
29
- | Action | Clauses lowered |
30
- | ------------------------ | ------------------------------------------------------------------------------------------------- |
31
- | `create` | `agent description`, `moves`, `steps`, `summary` |
32
- | `close` | `due`, `moves`, `steps`, `summary` |
33
- | `calculate` | `agent description`, `computes signed_sum`, `moves`, `steps`, `summary` |
34
- | `approve` | `agent description`, `moves`, `steps`, `summary` |
35
- | `instruct` | `agent description`, `moves`, `payout`, `steps`, `summary` |
36
- | `payout_acknowledgement` | `agent description`, `capture input`, `description`, `input`, `moves`, `port`, `steps`, `summary` |
37
- | `reconcile` | `due`, `moves`, `reconcile`, `steps`, `summary` |
38
- | `create` | `agent description`, `moves`, `steps`, `summary` |
39
- | `accrue` | `agent description`, `moves`, `steps`, `summary` |
40
- | `create` | `agent description`, `moves`, `steps`, `summary` |
41
- | `adjust` | `agent description`, `moves`, `steps`, `summary` |
42
- | `correct` | `agent description`, `moves`, `steps`, `summary` |
package/docs/reference/std/swap.md DELETED
@@ -1,46 +0,0 @@
1
- <!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
2
-
3
- # swap
4
-
5
- Source: [`std/settlements/swap.hsx`](../../../std/settlements/swap.hsx)
6
-
7
- ## Export
8
-
9
- `swap<C>`
10
-
11
- ## Parameters
12
-
13
- - `between: list<party>`
14
- - `amounts: block`
15
- - `fees: block`
16
- - `release: condition`
17
- - `dispute: condition`
18
- - `side_names: optional<block>`
19
- - `lifecycle_state_order: optional<list<text>>`
20
- - `action_bindings: optional<block>`
21
- - `parked_states: optional<block>`
22
- - `fixed_prefix: optional<text>`
23
-
24
- ## Decision ports
25
-
26
- - `release`
27
- - `dispute`
28
-
29
- ## Actions and clauses
30
-
31
- | Action | Clauses lowered |
32
- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
33
- | `abandon` | `agent description`, `moves`, `public action`, `steps`, `summary` |
34
- | `cancel` | `agent description`, `moves`, `public action`, `steps`, `summary` |
35
- | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
36
- | `dispute` | `agent description`, `deadline`, `moves`, `port`, `public action`, `steps`, `summary` |
37
- | `fund` | `agent description`, `moves`, `public action`, `steps`, `summary` |
38
- | `post` | `due`, `moves`, `steps`, `summary` |
39
- | `release` | `agent description`, `moves`, `port`, `public action`, `sets at`, `steps`, `summary` |
40
- | `create` | `agent description`, `moves`, `public action`, `steps`, `summary` |
41
- | `fund` | `agent description`, `event name`, `moves`, `public action`, `sandbox failure point`, `steps`, `summary` |
42
- | `release` | `agent description`, `event name`, `moves`, `port`, `public action`, `sandbox failure point`, `sets at`, `steps`, `summary` |
43
- | `post` | `due`, `event name`, `moves`, `steps`, `summary` |
44
- | `dispute` | `agent description`, `deadline`, `event name`, `moves`, `port`, `public action`, `steps`, `summary` |
45
- | `cancel` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |
46
- | `abandon` | `agent description`, `event name`, `moves`, `public action`, `steps`, `summary` |