@hyperscale0/hsx 2.0.0 → 2.0.2
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.
- package/CHANGELOG.md +25 -0
- package/dist/src/cli.d.ts +1 -1
- package/dist/src/diagnostics.d.ts.map +1 -1
- package/dist/src/diagnostics.js +7 -0
- package/dist/src/diagnostics.js.map +1 -1
- package/dist/src/std-bundle.js +19 -19
- package/dist/src/std-bundle.js.map +1 -1
- package/dist/src/typecheck.js +89 -1
- package/dist/src/typecheck.js.map +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/src/version.js +1 -1
- package/docs/guide/01-first-program.md +1 -1
- package/docs/guide/09-cost.md +1 -1
- package/docs/llms-full.txt +64 -39
- package/docs/llms.txt +2 -2
- package/docs/reference/cli.md +2 -2
- package/docs/reference/diagnostics.md +21 -1
- package/docs/reference/grammar.md +1 -1
- package/docs/reference/std/advance.md +1 -1
- package/docs/reference/std/cancellable_booking.md +1 -1
- package/docs/reference/std/captured_payment.md +1 -1
- package/docs/reference/std/conditional_disbursement.md +1 -1
- package/docs/reference/std/credit_facility.md +1 -1
- package/docs/reference/std/held_payment.md +41 -36
- package/docs/reference/std/instant_transfer.md +1 -1
- package/docs/reference/std/metered.md +1 -1
- package/docs/reference/std/pooled_split.md +1 -1
- package/docs/reference/std/premium_forward.md +1 -1
- package/docs/reference/std/reconciled_payout.md +1 -1
- package/docs/reference/std/recurring_collection.md +1 -1
- package/docs/reference/std/rotating_pool.md +1 -1
- package/docs/reference/std/scheduled.md +1 -1
- package/docs/reference/std/security_deposit.md +1 -1
- package/docs/reference/std/settlement_batch.md +1 -1
- package/docs/reference/std/swap.md +1 -1
- package/docs/reference/std/threshold_pool.md +1 -1
- package/docs/reference/std/weighted_distribution.md +1 -1
- package/docs/reference/types.md +1 -1
- package/docs/reference/udl-output.md +1 -1
- package/examples/advance/advance.udl +6 -6
- package/examples/cancellable_booking/cancellable_booking.udl +10 -10
- package/examples/captured_payment/captured_payment.udl +6 -6
- package/examples/conditional_disbursement/conditional_disbursement.udl +2 -2
- package/examples/cost-table.json +18 -78
- package/examples/credit_facility/credit_facility.udl +10 -10
- package/examples/held_payment/held_payment.udl +23 -12
- package/examples/instant_transfer/instant_transfer.udl +6 -6
- package/examples/metered/metered.udl +4 -4
- package/examples/pooled_split/pooled_split.udl +10 -10
- package/examples/premium_forward/premium_forward.udl +12 -12
- package/examples/recurring_collection/recurring_collection.udl +8 -8
- package/examples/rotating_pool/rotating_pool.udl +78 -78
- package/examples/scheduled/scheduled.udl +6 -6
- package/examples/security_deposit/security_deposit.udl +2 -2
- package/examples/swap/swap.udl +22 -22
- package/examples/threshold_pool/threshold_pool.udl +10 -10
- package/examples/weighted_distribution/weighted_distribution.udl +2 -2
- package/package.json +3 -3
- package/skills/hsx/SKILL.md +2 -2
- package/src/diagnostics.ts +10 -0
- package/src/std-bundle.ts +19 -19
- package/src/typecheck.ts +105 -1
- package/src/version.ts +1 -1
- package/std/money_flows/advance.hsx +45 -0
- package/std/money_flows/cancellable_booking.hsx +45 -0
- package/std/money_flows/captured_payment.hsx +55 -0
- package/std/money_flows/conditional_disbursement.hsx +46 -0
- package/std/money_flows/credit_facility.hsx +57 -0
- package/std/money_flows/held_payment.hsx +152 -3
- package/std/money_flows/instant_transfer.hsx +42 -0
- package/std/money_flows/metered.hsx +41 -0
- package/std/money_flows/pooled_split.hsx +41 -0
- package/std/money_flows/premium_forward.hsx +51 -0
- package/std/money_flows/reconciled_payout.hsx +42 -0
- package/std/money_flows/recurring_collection.hsx +45 -0
- package/std/money_flows/rotating_pool.hsx +51 -0
- package/std/money_flows/scheduled.hsx +53 -0
- package/std/money_flows/security_deposit.hsx +58 -0
- package/std/money_flows/settlement_batch.hsx +51 -0
- package/std/money_flows/swap.hsx +53 -0
- package/std/money_flows/threshold_pool.hsx +51 -0
- package/std/money_flows/weighted_distribution.hsx +54 -0
package/dist/src/version.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** Package version reported by the command line. */
|
|
2
|
-
export declare const HSX_VERSION = "2.0.
|
|
2
|
+
export declare const HSX_VERSION = "2.0.2";
|
|
3
3
|
/** Canonical UDL contract version emitted by this compiler. */
|
|
4
4
|
export declare const HSX_TARGET_UDL_VERSION = 1;
|
|
5
5
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/src/version.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** Package version reported by the command line. */
|
|
2
|
-
export const HSX_VERSION = "2.0.
|
|
2
|
+
export const HSX_VERSION = "2.0.2";
|
|
3
3
|
/** Canonical UDL contract version emitted by this compiler. */
|
|
4
4
|
export const HSX_TARGET_UDL_VERSION = 1;
|
|
5
5
|
//# sourceMappingURL=version.js.map
|
|
@@ -21,4 +21,4 @@ settlement tip = instant_transfer {
|
|
|
21
21
|
|
|
22
22
|
A port declares a decision that an external caller may supply. The port names the parties allowed to answer and may define a typed input shape. Use a port only when the selected instrument accepts a condition parameter.
|
|
23
23
|
|
|
24
|
-
After package installation, run `npx hsx check product.hsx` while editing and `npx hsx build product.hsx --out product.udl.json` when the program passes. In a repository checkout, run `bun install` once, then use `bun run bin/hsx.ts check product.hsx` and `bun run bin/hsx.ts build product.hsx --out product.udl.json`.
|
|
24
|
+
After package installation, run `npx @hyperscale0/hsx check product.hsx` while editing and `npx @hyperscale0/hsx build product.hsx --out product.udl.json` when the program passes. In a repository checkout, run `bun install` once, then use `bun run bin/hsx.ts check product.hsx` and `bun run bin/hsx.ts build product.hsx --out product.udl.json`.
|
package/docs/guide/09-cost.md
CHANGED
|
@@ -19,6 +19,6 @@ Read an action line as `instrument.action`, followed by the effect signature and
|
|
|
19
19
|
|
|
20
20
|
The monthly estimate is an expression over declared meter variables. Billing supplies observed readings to that frozen expression. Recomposition emits a new manifest for the next commercial snapshot. It does not rewrite a prior manifest. During recomposition planning, compose plan calculates the candidate program's proposed estimate and reconciles it against the current Build's frozen pricing quote. The existing Product retains its frozen quote until the recomposition is applied.
|
|
21
21
|
|
|
22
|
-
An effect without a price row reports `HSX1301`. An invalid price reports `HSX1302`. A missing cost table also reports `HSX1301`. `examples/cost-table.json` ships one rate card per priced billing currency; the compiler picks the card whose currency the program's money fields move. Money in a currency no card prices reports `HSX1304`, and money in two currencies reports `HSX1305`: a program bills in one ledger currency. Do not create another table for documentation.
|
|
22
|
+
An effect without a price row reports `HSX1301`. An invalid price reports `HSX1302`. A missing cost table also reports `HSX1301`. `examples/cost-table.json` ships one rate card per priced billing currency; the compiler picks the card whose currency the program's money fields move. Money in a currency no card prices reports `HSX1304`, and money in two currencies reports `HSX1305`: a program bills in one ledger currency. A move of a `money<SAR>` field moves SAR whatever the caller wrote in the instance currency field: the compiler pins the move's currency binding to the constant, and a binding it cannot pin reports `HSX1306`. Do not create another table for documentation.
|
|
23
23
|
|
|
24
24
|
Do not confuse an action `quote` with the commercial cost manifest. `cancellable_booking.cancel` quotes a customer-visible cancellation penalty and `confirm` commits it. The compiler counts an instrument that carries a quote as unwind work because an expired or abandoned offer still needs bounded cleanup. The cost manifest prices that runtime work from the shipped rate card. It does not replace, spend, or alter the quoted financial amount.
|
package/docs/llms-full.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!-- Generated by scripts/docs/build.ts for HSX 2.0.
|
|
1
|
+
<!-- Generated by scripts/docs/build.ts for HSX 2.0.2. Do not edit. -->
|
|
2
2
|
|
|
3
3
|
# HSX full documentation
|
|
4
4
|
|
|
@@ -25,7 +25,7 @@ settlement tip = instant_transfer {
|
|
|
25
25
|
|
|
26
26
|
A port declares a decision that an external caller may supply. The port names the parties allowed to answer and may define a typed input shape. Use a port only when the selected instrument accepts a condition parameter.
|
|
27
27
|
|
|
28
|
-
After package installation, run `npx hsx check product.hsx` while editing and `npx hsx build product.hsx --out product.udl.json` when the program passes. In a repository checkout, run `bun install` once, then use `bun run bin/hsx.ts check product.hsx` and `bun run bin/hsx.ts build product.hsx --out product.udl.json`.
|
|
28
|
+
After package installation, run `npx @hyperscale0/hsx check product.hsx` while editing and `npx @hyperscale0/hsx build product.hsx --out product.udl.json` when the program passes. In a repository checkout, run `bun install` once, then use `bun run bin/hsx.ts check product.hsx` and `bun run bin/hsx.ts build product.hsx --out product.udl.json`.
|
|
29
29
|
|
|
30
30
|
# Money
|
|
31
31
|
|
|
@@ -339,7 +339,7 @@ Read an action line as `instrument.action`, followed by the effect signature and
|
|
|
339
339
|
|
|
340
340
|
The monthly estimate is an expression over declared meter variables. Billing supplies observed readings to that frozen expression. Recomposition emits a new manifest for the next commercial snapshot. It does not rewrite a prior manifest. During recomposition planning, compose plan calculates the candidate program's proposed estimate and reconciles it against the current Build's frozen pricing quote. The existing Product retains its frozen quote until the recomposition is applied.
|
|
341
341
|
|
|
342
|
-
An effect without a price row reports `HSX1301`. An invalid price reports `HSX1302`. A missing cost table also reports `HSX1301`. `examples/cost-table.json` ships one rate card per priced billing currency; the compiler picks the card whose currency the program's money fields move. Money in a currency no card prices reports `HSX1304`, and money in two currencies reports `HSX1305`: a program bills in one ledger currency. Do not create another table for documentation.
|
|
342
|
+
An effect without a price row reports `HSX1301`. An invalid price reports `HSX1302`. A missing cost table also reports `HSX1301`. `examples/cost-table.json` ships one rate card per priced billing currency; the compiler picks the card whose currency the program's money fields move. Money in a currency no card prices reports `HSX1304`, and money in two currencies reports `HSX1305`: a program bills in one ledger currency. A move of a `money<SAR>` field moves SAR whatever the caller wrote in the instance currency field: the compiler pins the move's currency binding to the constant, and a binding it cannot pin reports `HSX1306`. Do not create another table for documentation.
|
|
343
343
|
|
|
344
344
|
Do not confuse an action `quote` with the commercial cost manifest. `cancellable_booking.cancel` quotes a customer-visible cancellation penalty and `confirm` commits it. The compiler counts an instrument that carries a quote as unwind work because an expired or abandoned offer still needs bounded cleanup. The cost manifest prices that runtime work from the shipped rate card. It does not replace, spend, or alter the quoted financial amount.
|
|
345
345
|
|
|
@@ -374,7 +374,7 @@ Exit code `0` means the command accepted the program. Exit code `1` means compil
|
|
|
374
374
|
# CLI
|
|
375
375
|
|
|
376
376
|
```text
|
|
377
|
-
hsx 2.0.
|
|
377
|
+
hsx 2.0.2, the HSX compiler
|
|
378
378
|
|
|
379
379
|
Usage:
|
|
380
380
|
hsx check <file.hsx> [--strict]
|
|
@@ -938,6 +938,26 @@ instrument probe {
|
|
|
938
938
|
}
|
|
939
939
|
```
|
|
940
940
|
|
|
941
|
+
## HSX1306: Fixed-currency amount moved in another currency
|
|
942
|
+
|
|
943
|
+
Stage: `typecheck`
|
|
944
|
+
|
|
945
|
+
Fix: Bind the currency of a money<CUR> move or account step as the constant CUR; the compiler pins a binding that reads the instrument's currency field.
|
|
946
|
+
|
|
947
|
+
```hsx expect=HSX1306
|
|
948
|
+
program catalog_probe "Catalog probe"
|
|
949
|
+
instrument probe {
|
|
950
|
+
agent_description: "Probe instrument for catalog diagnostics.";
|
|
951
|
+
fields { amount: money<SAR>; payeeAccountId: account<SAR>; payerAccountId: account<SAR>; }
|
|
952
|
+
lifecycle { states created; initial created; }
|
|
953
|
+
action create {
|
|
954
|
+
agent_description: "Create a probe instance.";
|
|
955
|
+
steps: [];
|
|
956
|
+
}
|
|
957
|
+
action pay { agent_description: "Pay the amount."; moves: [{ "bind": { "amount": { "from": "instance"; "path": "fields.amount"; }; "currency": { "from": "const"; "value": "USD"; }; "destinationAccountId": { "from": "instance"; "path": "fields.payeeAccountId"; }; "sourceAccountId": { "from": "instance"; "path": "fields.payerAccountId"; }; }; "key": "transfer"; "operation": "internal_transfer.create"; }]; steps: []; }
|
|
958
|
+
}
|
|
959
|
+
```
|
|
960
|
+
|
|
941
961
|
## HSX1401: Unbounded action
|
|
942
962
|
|
|
943
963
|
Stage: `typecheck`
|
|
@@ -1447,6 +1467,8 @@ Source: [`std/money_flows/held_payment.hsx`](../../../std/money_flows/held_payme
|
|
|
1447
1467
|
- `reference: optional<text>`
|
|
1448
1468
|
- `upstream: optional<ref>`
|
|
1449
1469
|
- `id_prefix_override: optional<text>`
|
|
1470
|
+
- `cancel_charge_bps: optional<integer>`
|
|
1471
|
+
- `cancel_offer_life: optional<text>`
|
|
1450
1472
|
|
|
1451
1473
|
## Decision ports
|
|
1452
1474
|
|
|
@@ -1454,41 +1476,44 @@ Source: [`std/money_flows/held_payment.hsx`](../../../std/money_flows/held_payme
|
|
|
1454
1476
|
|
|
1455
1477
|
## Actions and clauses
|
|
1456
1478
|
|
|
1457
|
-
| Action
|
|
1458
|
-
|
|
|
1459
|
-
| `fund_piece_2`
|
|
1460
|
-
| `fund_piece_3`
|
|
1461
|
-
| `collect_service_fee`
|
|
1462
|
-
| `release_piece_2`
|
|
1463
|
-
| `release_piece_3`
|
|
1464
|
-
| `refund_piece_2`
|
|
1465
|
-
| `refund_piece_3`
|
|
1466
|
-
| `unfund_piece_1`
|
|
1467
|
-
| `unfund_piece_2`
|
|
1468
|
-
| `unfund_piece_3`
|
|
1469
|
-
| `create`
|
|
1470
|
-
| `fund_piece_1`
|
|
1471
|
-
| `release_name`
|
|
1472
|
-
| `release_on_deadline`
|
|
1473
|
-
| `cancel`
|
|
1474
|
-
| `
|
|
1475
|
-
| `
|
|
1476
|
-
| `
|
|
1477
|
-
| `fund_piece_2`
|
|
1478
|
-
| `release_piece_2`
|
|
1479
|
-
| `
|
|
1480
|
-
| `
|
|
1481
|
-
| `
|
|
1482
|
-
| `
|
|
1483
|
-
| `
|
|
1484
|
-
| `
|
|
1485
|
-
| `
|
|
1486
|
-
| `
|
|
1487
|
-
| `
|
|
1488
|
-
| `
|
|
1489
|
-
| `
|
|
1490
|
-
| `
|
|
1491
|
-
| `
|
|
1479
|
+
| Action | Clauses lowered |
|
|
1480
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
1481
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1482
|
+
| `fund_piece_3` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1483
|
+
| `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
|
|
1484
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1485
|
+
| `release_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
1486
|
+
| `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1487
|
+
| `refund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
1488
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
1489
|
+
| `unfund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1490
|
+
| `unfund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
1491
|
+
| `create` | `agent description`, `moves`, `steps`, `summary` |
|
|
1492
|
+
| `fund_piece_1` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1493
|
+
| `release_name` | `agent description`, `deadline`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
|
|
1494
|
+
| `release_on_deadline` | `due`, `moves`, `steps`, `summary` |
|
|
1495
|
+
| `cancel` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
|
|
1496
|
+
| `quote_cancellation` | `agent description`, `deadline`, `moves`, `quote`, `steps`, `summary` |
|
|
1497
|
+
| `cancel` | `agent description`, `commit`, `deadline`, `moves`, `steps`, `summary` |
|
|
1498
|
+
| `retain_cancellation_charge` | `agent description`, `moves`, `steps`, `summary` |
|
|
1499
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1500
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1501
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
1502
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1503
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1504
|
+
| `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
1505
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
1506
|
+
| `abandon` | `agent description`, `moves`, `steps`, `summary` |
|
|
1507
|
+
| `dispute` | `agent description`, `deadline`, `description`, `moves`, `steps`, `summary` |
|
|
1508
|
+
| `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
|
|
1509
|
+
| `create` | `agent description`, `moves`, `steps`, `summary` |
|
|
1510
|
+
| `fund` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
1511
|
+
| `release_action` | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
|
|
1512
|
+
| `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary` |
|
|
1513
|
+
| `cancel` | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary` |
|
|
1514
|
+
| `abandon` | `agent description`, `moves`, `steps`, `summary` |
|
|
1515
|
+
| `dispute` | `agent description`, `deadline`, `description`, `moves`, `steps`, `summary` |
|
|
1516
|
+
| `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
|
|
1492
1517
|
|
|
1493
1518
|
# instant_transfer
|
|
1494
1519
|
|
package/docs/llms.txt
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!-- Generated by scripts/docs/build.ts for HSX 2.0.
|
|
1
|
+
<!-- Generated by scripts/docs/build.ts for HSX 2.0.2. Do not edit. -->
|
|
2
2
|
|
|
3
3
|
# HSX documentation
|
|
4
4
|
|
|
5
|
-
> Repository guide and generated compiler reference for HSX 2.0.
|
|
5
|
+
> Repository guide and generated compiler reference for HSX 2.0.2.
|
|
6
6
|
|
|
7
7
|
## Guide
|
|
8
8
|
|
package/docs/reference/cli.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
<!-- Generated by scripts/docs/build.ts for HSX 2.0.
|
|
1
|
+
<!-- Generated by scripts/docs/build.ts for HSX 2.0.2. Do not edit. -->
|
|
2
2
|
|
|
3
3
|
# CLI
|
|
4
4
|
|
|
5
5
|
```text
|
|
6
|
-
hsx 2.0.
|
|
6
|
+
hsx 2.0.2, the HSX compiler
|
|
7
7
|
|
|
8
8
|
Usage:
|
|
9
9
|
hsx check <file.hsx> [--strict]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!-- Generated by scripts/docs/build.ts for HSX 2.0.
|
|
1
|
+
<!-- Generated by scripts/docs/build.ts for HSX 2.0.2. Do not edit. -->
|
|
2
2
|
|
|
3
3
|
# Diagnostics
|
|
4
4
|
|
|
@@ -533,6 +533,26 @@ instrument probe {
|
|
|
533
533
|
}
|
|
534
534
|
```
|
|
535
535
|
|
|
536
|
+
## HSX1306: Fixed-currency amount moved in another currency
|
|
537
|
+
|
|
538
|
+
Stage: `typecheck`
|
|
539
|
+
|
|
540
|
+
Fix: Bind the currency of a money<CUR> move or account step as the constant CUR; the compiler pins a binding that reads the instrument's currency field.
|
|
541
|
+
|
|
542
|
+
```hsx expect=HSX1306
|
|
543
|
+
program catalog_probe "Catalog probe"
|
|
544
|
+
instrument probe {
|
|
545
|
+
agent_description: "Probe instrument for catalog diagnostics.";
|
|
546
|
+
fields { amount: money<SAR>; payeeAccountId: account<SAR>; payerAccountId: account<SAR>; }
|
|
547
|
+
lifecycle { states created; initial created; }
|
|
548
|
+
action create {
|
|
549
|
+
agent_description: "Create a probe instance.";
|
|
550
|
+
steps: [];
|
|
551
|
+
}
|
|
552
|
+
action pay { agent_description: "Pay the amount."; moves: [{ "bind": { "amount": { "from": "instance"; "path": "fields.amount"; }; "currency": { "from": "const"; "value": "USD"; }; "destinationAccountId": { "from": "instance"; "path": "fields.payeeAccountId"; }; "sourceAccountId": { "from": "instance"; "path": "fields.payerAccountId"; }; }; "key": "transfer"; "operation": "internal_transfer.create"; }]; steps: []; }
|
|
553
|
+
}
|
|
554
|
+
```
|
|
555
|
+
|
|
536
556
|
## HSX1401: Unbounded action
|
|
537
557
|
|
|
538
558
|
Stage: `typecheck`
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!-- Generated by scripts/docs/build.ts for HSX 2.0.
|
|
1
|
+
<!-- Generated by scripts/docs/build.ts for HSX 2.0.2. Do not edit. -->
|
|
2
2
|
|
|
3
3
|
# held_payment
|
|
4
4
|
|
|
@@ -24,6 +24,8 @@ Source: [`std/money_flows/held_payment.hsx`](../../../std/money_flows/held_payme
|
|
|
24
24
|
- `reference: optional<text>`
|
|
25
25
|
- `upstream: optional<ref>`
|
|
26
26
|
- `id_prefix_override: optional<text>`
|
|
27
|
+
- `cancel_charge_bps: optional<integer>`
|
|
28
|
+
- `cancel_offer_life: optional<text>`
|
|
27
29
|
|
|
28
30
|
## Decision ports
|
|
29
31
|
|
|
@@ -31,38 +33,41 @@ Source: [`std/money_flows/held_payment.hsx`](../../../std/money_flows/held_payme
|
|
|
31
33
|
|
|
32
34
|
## Actions and clauses
|
|
33
35
|
|
|
34
|
-
| Action
|
|
35
|
-
|
|
|
36
|
-
| `fund_piece_2`
|
|
37
|
-
| `fund_piece_3`
|
|
38
|
-
| `collect_service_fee`
|
|
39
|
-
| `release_piece_2`
|
|
40
|
-
| `release_piece_3`
|
|
41
|
-
| `refund_piece_2`
|
|
42
|
-
| `refund_piece_3`
|
|
43
|
-
| `unfund_piece_1`
|
|
44
|
-
| `unfund_piece_2`
|
|
45
|
-
| `unfund_piece_3`
|
|
46
|
-
| `create`
|
|
47
|
-
| `fund_piece_1`
|
|
48
|
-
| `release_name`
|
|
49
|
-
| `release_on_deadline`
|
|
50
|
-
| `cancel`
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `fund_piece_2`
|
|
55
|
-
| `release_piece_2`
|
|
56
|
-
| `
|
|
57
|
-
| `
|
|
58
|
-
| `
|
|
59
|
-
| `
|
|
60
|
-
| `
|
|
61
|
-
| `
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
36
|
+
| Action | Clauses lowered |
|
|
37
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
|
|
38
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
39
|
+
| `fund_piece_3` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
40
|
+
| `collect_service_fee` | `agent description`, `moves`, `steps`, `summary` |
|
|
41
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
42
|
+
| `release_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
43
|
+
| `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
44
|
+
| `refund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
45
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
46
|
+
| `unfund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
47
|
+
| `unfund_piece_3` | `agent description`, `moves`, `steps`, `summary` |
|
|
48
|
+
| `create` | `agent description`, `moves`, `steps`, `summary` |
|
|
49
|
+
| `fund_piece_1` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
50
|
+
| `release_name` | `agent description`, `deadline`, `input`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
|
|
51
|
+
| `release_on_deadline` | `due`, `moves`, `steps`, `summary` |
|
|
52
|
+
| `cancel` | `agent description`, `deadline`, `moves`, `steps`, `summary` |
|
|
53
|
+
| `quote_cancellation` | `agent description`, `deadline`, `moves`, `quote`, `steps`, `summary` |
|
|
54
|
+
| `cancel` | `agent description`, `commit`, `deadline`, `moves`, `steps`, `summary` |
|
|
55
|
+
| `retain_cancellation_charge` | `agent description`, `moves`, `steps`, `summary` |
|
|
56
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
57
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
58
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
59
|
+
| `fund_piece_2` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
60
|
+
| `release_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
61
|
+
| `refund_piece_2` | `agent description`, `moves`, `steps`, `summary` |
|
|
62
|
+
| `unfund_piece_1` | `agent description`, `moves`, `steps`, `summary` |
|
|
63
|
+
| `abandon` | `agent description`, `moves`, `steps`, `summary` |
|
|
64
|
+
| `dispute` | `agent description`, `deadline`, `description`, `moves`, `steps`, `summary` |
|
|
65
|
+
| `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
|
|
66
|
+
| `create` | `agent description`, `moves`, `steps`, `summary` |
|
|
67
|
+
| `fund` | `agent description`, `moves`, `sandbox failure point`, `steps`, `summary` |
|
|
68
|
+
| `release_action` | `agent description`, `deadline`, `moves`, `port`, `sandbox failure point`, `steps`, `summary` |
|
|
69
|
+
| `release_on_deadline` | `due`, `event name`, `moves`, `steps`, `summary` |
|
|
70
|
+
| `cancel` | `agent description`, `deadline`, `event name`, `moves`, `steps`, `summary` |
|
|
71
|
+
| `abandon` | `agent description`, `moves`, `steps`, `summary` |
|
|
72
|
+
| `dispute` | `agent description`, `deadline`, `description`, `moves`, `steps`, `summary` |
|
|
73
|
+
| `resume` | `agent description`, `description`, `moves`, `steps`, `summary` |
|
package/docs/reference/types.md
CHANGED
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"path": "fields.repayment1Amount"
|
|
35
35
|
},
|
|
36
36
|
"currency": {
|
|
37
|
-
"from": "
|
|
38
|
-
"
|
|
37
|
+
"from": "const",
|
|
38
|
+
"value": "SAR"
|
|
39
39
|
},
|
|
40
40
|
"destinationAccountId": {
|
|
41
41
|
"from": "instance",
|
|
@@ -99,8 +99,8 @@
|
|
|
99
99
|
"path": "fields.repayment2Amount"
|
|
100
100
|
},
|
|
101
101
|
"currency": {
|
|
102
|
-
"from": "
|
|
103
|
-
"
|
|
102
|
+
"from": "const",
|
|
103
|
+
"value": "SAR"
|
|
104
104
|
},
|
|
105
105
|
"destinationAccountId": {
|
|
106
106
|
"from": "instance",
|
|
@@ -162,8 +162,8 @@
|
|
|
162
162
|
"path": "fields.principal"
|
|
163
163
|
},
|
|
164
164
|
"currency": {
|
|
165
|
-
"from": "
|
|
166
|
-
"
|
|
165
|
+
"from": "const",
|
|
166
|
+
"value": "SAR"
|
|
167
167
|
},
|
|
168
168
|
"destinationAccountId": {
|
|
169
169
|
"from": "instance",
|
|
@@ -80,8 +80,8 @@
|
|
|
80
80
|
"path": "fields.sessionPrice"
|
|
81
81
|
},
|
|
82
82
|
"currency": {
|
|
83
|
-
"from": "
|
|
84
|
-
"
|
|
83
|
+
"from": "const",
|
|
84
|
+
"value": "SAR"
|
|
85
85
|
},
|
|
86
86
|
"destinationAccountId": {
|
|
87
87
|
"from": "instance",
|
|
@@ -125,8 +125,8 @@
|
|
|
125
125
|
"path": "refs.cancellationRefundAmount"
|
|
126
126
|
},
|
|
127
127
|
"currency": {
|
|
128
|
-
"from": "
|
|
129
|
-
"
|
|
128
|
+
"from": "const",
|
|
129
|
+
"value": "SAR"
|
|
130
130
|
},
|
|
131
131
|
"destinationAccountId": {
|
|
132
132
|
"from": "instance",
|
|
@@ -160,8 +160,8 @@
|
|
|
160
160
|
{
|
|
161
161
|
"bind": {
|
|
162
162
|
"currency": {
|
|
163
|
-
"from": "
|
|
164
|
-
"
|
|
163
|
+
"from": "const",
|
|
164
|
+
"value": "SAR"
|
|
165
165
|
},
|
|
166
166
|
"owner.id": {
|
|
167
167
|
"from": "instance",
|
|
@@ -206,8 +206,8 @@
|
|
|
206
206
|
"path": "refs.cancellationPenaltyAmount"
|
|
207
207
|
},
|
|
208
208
|
"currency": {
|
|
209
|
-
"from": "
|
|
210
|
-
"
|
|
209
|
+
"from": "const",
|
|
210
|
+
"value": "SAR"
|
|
211
211
|
},
|
|
212
212
|
"destinationAccountId": {
|
|
213
213
|
"from": "instance",
|
|
@@ -251,8 +251,8 @@
|
|
|
251
251
|
"path": "fields.sessionPrice"
|
|
252
252
|
},
|
|
253
253
|
"currency": {
|
|
254
|
-
"from": "
|
|
255
|
-
"
|
|
254
|
+
"from": "const",
|
|
255
|
+
"value": "SAR"
|
|
256
256
|
},
|
|
257
257
|
"destinationAccountId": {
|
|
258
258
|
"from": "instance",
|