@hyperscale0/hsx 2.4.1 → 3.0.1

package/examples/advance/advance.udl

@@ -1,367 +0,0 @@
-{
-  "instruments": [
-    {
-      "actionOrder": [
-        "create",
-        "disburse",
-        "collect_repayment_1",
-        "collect_repayment_2"
-      ],
-      "actions": {
-        "collect_repayment_1": {
-          "agentDescription": "Collect repayment 1 once on its stored due anchor, returning principal to the funder and any separately routed profit to its recipient.",
-          "due": {
-            "field": "firstDueAt",
-            "offset": "P0D"
-          },
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ],
-            "schedules": [
-              {
-                "signature": "schedules.due",
-                "source": "due"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.repayment1Amount"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.funderAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "advance_payment"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "collect_repayment_1"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.recipientAccountId"
-                }
-              },
-              "capture": {
-                "collectRepayment1TransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "steps": [],
-          "summary": "Collect repayment 1 of 2"
-        },
-        "collect_repayment_2": {
-          "agentDescription": "Collect repayment 2 once on its stored due anchor, returning principal to the funder and any separately routed profit to its recipient.",
-          "due": {
-            "field": "firstDueAt",
-            "offset": "P30D"
-          },
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ],
-            "schedules": [
-              {
-                "signature": "schedules.due",
-                "source": "due"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.repayment2Amount"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.funderAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "advance_payment"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "collect_repayment_2"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.recipientAccountId"
-                }
-              },
-              "capture": {
-                "collectRepayment2TransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "steps": [],
-          "summary": "Collect repayment 2 of 2"
-        },
-        "create": {
-          "agentDescription": "Open the advance row before any money moves. The caller supplies the principal, the repayable total, and repayment dates. A declared fee derives the fee amount from principal. The repayment fields must partition the repayable total exactly. Nothing is disbursed here.",
-          "moves": [],
-          "publicAction": "createAdvancePayment",
-          "steps": [],
-          "summary": "Create a advance payment"
-        },
-        "disburse": {
-          "agentDescription": "Pay the principal from the funder to the recipient and start the repayment schedule. The advance must be created. The transfer posts straight out and does not unwind. Each repayment is collected on its own stored date anchor.",
-          "effects": {
-            "moves": [
-              {
-                "signature": "moves.transfer.internal",
-                "source": "moves[0]"
-              }
-            ]
-          },
-          "moves": [
-            {
-              "bind": {
-                "amount": {
-                  "from": "instance",
-                  "path": "fields.principal"
-                },
-                "currency": {
-                  "from": "const",
-                  "value": "SAR"
-                },
-                "destinationAccountId": {
-                  "from": "instance",
-                  "path": "fields.recipientAccountId"
-                },
-                "metadata.instrumentId": {
-                  "from": "const",
-                  "value": "advance_payment"
-                },
-                "metadata.instrumentInstanceId": {
-                  "from": "instance",
-                  "path": "instrumentInstanceId"
-                },
-                "metadata.phase": {
-                  "from": "const",
-                  "value": "disburse"
-                },
-                "productId": {
-                  "from": "instance",
-                  "path": "productId"
-                },
-                "sourceAccountId": {
-                  "from": "instance",
-                  "path": "fields.funderAccountId"
-                }
-              },
-              "capture": {
-                "disburseTransferTransferId": "transferId"
-              },
-              "key": "transfer",
-              "operation": "internal_transfer.create"
-            }
-          ],
-          "publicAction": "disburseAdvancePayment",
-          "steps": [],
-          "summary": "Disburse the principal to the recipient"
-        }
-      },
-      "agentDescription": "Reach for advance when the funder pays the recipient up front and is repaid afterwards, either out of a carved hold release or over scheduled repayments. Pick deposit for a refundable reservation and instant transfer when nobody repays the payer.",
-      "derivedAmounts": [
-        {
-          "field": "feeAmount",
-          "rounding": "floor",
-          "rule": {
-            "bps": 250,
-            "kind": "percentage_of"
-          },
-          "sourceField": "principal"
-        }
-      ],
-      "description": "Advance: the funder disburses principal to the recipient, repaid over 2 scheduled repayments plus the funder's discount",
-      "fields": {
-        "currency": {
-          "description": "ISO 4217 currency code",
-          "maxLength": 3,
-          "minLength": 3,
-          "pattern": "^[A-Z]{3}$",
-          "type": "string"
-        },
-        "feeAmount": {
-          "description": "2.5% of principal, the funder's discount repaid on top of the advance",
-          "pattern": "^(0|[1-9][0-9]{0,17})$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "firstDueAt": {
-          "description": "Due date of the first repayment; repayment k falls P30D after its predecessor",
-          "format": "hyperscale-date-time",
-          "type": "string"
-        },
-        "funderAccountId": {
-          "description": "The funder account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "principal": {
-          "description": "The advanced amount in SAR minor units, disbursed to the recipient up front",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "recipientAccountId": {
-          "description": "The recipient account",
-          "pattern": "^acct_(sandbox|live)_[a-z0-9]{8,64}$",
-          "type": "string",
-          "x-hyperscale-reference-filter": {
-            "column": "role",
-            "values": [
-              "customer_balance"
-            ]
-          }
-        },
-        "repayableAmount": {
-          "description": "principal + feeAmount: the total the repayment fields below partition exactly",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "repayment1Amount": {
-          "description": "Stored total for repayment 1",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        },
-        "repayment2Amount": {
-          "description": "Stored total for repayment 2",
-          "pattern": "^[1-9][0-9]{0,17}$",
-          "type": "string",
-          "x-hyperscale-currency": "SAR"
-        }
-      },
-      "id": "advance_payment",
-      "idPrefix": "ap",
-      "lifecycle": {
-        "initial": "created",
-        "states": [
-          "created",
-          "advanced",
-          "repaying_1",
-          "repaid"
-        ],
-        "transitions": {
-          "collect_repayment_1": {
-            "from": [
-              "advanced"
-            ],
-            "to": "repaying_1"
-          },
-          "collect_repayment_2": {
-            "from": [
-              "repaying_1"
-            ],
-            "to": "repaid"
-          },
-          "disburse": {
-            "from": [
-              "created"
-            ],
-            "to": "advanced"
-          }
-        }
-      },
-      "parties": {
-        "beneficiary": "recipientAccountId",
-        "payer": "funderAccountId"
-      },
-      "partitions": [
-        {
-          "pieceFields": [
-            "repayment1Amount",
-            "repayment2Amount"
-          ],
-          "totalField": "repayableAmount"
-        },
-        {
-          "pieceFields": [
-            "principal",
-            "feeAmount"
-          ],
-          "totalField": "repayableAmount"
-        }
-      ],
-      "required": [
-        "funderAccountId",
-        "recipientAccountId",
-        "principal",
-        "repayableAmount",
-        "firstDueAt",
-        "repayment1Amount",
-        "repayment2Amount",
-        "currency"
-      ],
-      "summary": "Advance to recipient repaid over 2 anchors",
-      "templateBinding": {
-        "id": "advance",
-        "parameters": {
-          "against": false,
-          "count": 2,
-          "dated": false,
-          "profitTo": false,
-          "repaymentSource": false
-        }
-      },
-      "title": "Advance payment"
-    }
-  ],
-  "product": "advance_example",
-  "subjects": [],
-  "title": "Advance example",
-  "udl": 1,
-  "version": 1
-}

package/examples/cancellable_booking/README.md

@@ -1,3 +0,0 @@
-# cancellable_booking
-
-This example applies the `cancellable_booking` standard-library module. Its sibling UDL file pins the canonical compiler output byte for byte. The company and parties are invented.

package/examples/cancellable_booking/cancellable_booking.hsx

@@ -1,14 +0,0 @@
-program cancellable_booking_example "Cancellable booking example"
-import { cancellable_booking } from "std/money_flows"
-party guest: person
-party studio: business
-settlement studio_session = cancellable_booking {
-  guest: guest
-  host: studio
-  amount: sessionPrice: money(SAR)
-  starts_at: startsAt
-  late_penalty_bps: 5000
-  late_within: P2D
-  early_penalty_bps: 1000
-  offer_life: PT30M
-}