@hyperscale0/hsx 5.4.1 → 5.5.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# HSX 5.5.0
+
+Std money moves declare posted economic purposes. Fee legs and recipient choices
+retain separate purposes. Paid earnings and payout refunds retain their original
+transfer identity. Supports UDL pass-through money.
+
+# HSX 5.4.2
+
+Follows UDL 4.6.0: an action's `availability` carries `blockers` with a code and a plain reason instead of one code; an adapter that is not set up reads as `setup_required`. Tests updated. No compiler behaviour changed.
+
 # HSX 5.4.1
 
 Documentation only. The newcomer path now starts from a rental deposit

package/dist/src/compile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAeL,KAAK,WAAW,EAOjB,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAIL,KAAK,UAAU,EAKf,KAAK,IAAI,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAA0B,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CACpC;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AACD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAClE;AACD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,WAAW,CAAC;QACtB,YAAY,EAAE,eAAe,CAAC;QAC9B,SAAS,EAAE,qBAAqB,EAAE,CAAC;KACpC,CAAC;CACH;AAqTD,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB,GAC3B,aAAa,CAmjGf"}
+{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAeL,KAAK,WAAW,EAOjB,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAIL,KAAK,UAAU,EAKf,KAAK,IAAI,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAA0B,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CACpC;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AACD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAClE;AACD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,WAAW,CAAC;QACtB,YAAY,EAAE,eAAe,CAAC;QAC9B,SAAS,EAAE,qBAAqB,EAAE,CAAC;KACpC,CAAC;CACH;AAqTD,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB,GAC3B,aAAa,CAmrGf"}

package/dist/src/compile.js

@@ -1677,6 +1677,77 @@ export function compile(source, options = {}) {
                             const key = parts.has("key")
                                 ? String(data(parts.get("key")))
                                 : `move${index + 1}`;
+                            const lowerEconomics = (economicsExpr) => {
+                                if (economicsExpr) {
+                                    const resolved = resolve(economicsExpr);
+                                    if (resolved.kind === "name" &&
+                                        resolved.value === "unclassified")
+                                        return undefined;
+                                    const choices = entries(asBlock(resolve(economicsExpr)));
+                                    if (choices.has("recipient")) {
+                                        for (const term of choices.keys())
+                                            if (!["recipient", "company", "participant"].includes(term))
+                                                fail(economicsExpr, `unknown economics choice ${term}`, "use recipient, company and participant");
+                                        const recipient = String(data(choices.get("recipient")));
+                                        if (!isParty(recipient) ||
+                                            !choices.has("company") ||
+                                            !choices.has("participant"))
+                                            fail(economicsExpr, "economics choice needs a bound recipient and both branches", "declare recipient, company and participant");
+                                        const company = recipient === "operator" ||
+                                            recipient === "programOperator" ||
+                                            document.parties[recipient]?.role === "program_operator";
+                                        return lowerEconomics(choices.get(company ? "company" : "participant"));
+                                    }
+                                }
+                                const economicsParts = economicsExpr
+                                    ? entries(asBlock(resolve(economicsExpr)))
+                                    : undefined;
+                                if (economicsParts) {
+                                    for (const term of economicsParts.keys())
+                                        if (!["purpose", "sourceParty", "reversalOf"].includes(term))
+                                            fail(economicsExpr, `unknown economics term ${term}`, "use purpose, sourceParty or reversalOf");
+                                }
+                                const purpose = economicsParts?.get("purpose");
+                                const sourceParty = economicsParts?.get("sourceParty");
+                                if (economicsParts && (!purpose || !sourceParty))
+                                    fail(economicsExpr, "economics needs purpose and sourceParty", "declare both economics fields");
+                                const purposeName = purpose ? String(data(purpose)) : undefined;
+                                if (purposeName &&
+                                    ![
+                                        "earning",
+                                        "principal",
+                                        "participant_payout",
+                                        "internal",
+                                        "prepaid_credit",
+                                        "pass_through",
+                                    ].includes(purposeName))
+                                    fail(purpose, `unknown economic purpose ${purposeName}`, "choose a declared economic purpose");
+                                const sourcePartyName = sourceParty
+                                    ? String(data(sourceParty))
+                                    : undefined;
+                                if (sourcePartyName && !isParty(sourcePartyName))
+                                    fail(sourceParty, `unknown source party ${sourcePartyName}`, "bind an authored party");
+                                return economicsParts
+                                    ? {
+                                        purpose: purposeName,
+                                        sourceParty: sourcePartyName,
+                                        ...(economicsParts.has("reversalOf")
+                                            ? {
+                                                reversalOf: path(economicsParts.get("reversalOf")),
+                                            }
+                                            : {}),
+                                    }
+                                    : undefined;
+                            };
+                            const economicsExpr = parts.get("economics");
+                            const feeEconomics = parts.has("fee") && economicsExpr
+                                ? entries(asBlock(resolve(economicsExpr)))
+                                : undefined;
+                            if (feeEconomics)
+                                for (const term of feeEconomics.keys())
+                                    if (!["payee", "fee", "tax"].includes(term))
+                                        fail(economicsExpr, `unknown fee economics leg ${term}`, "declare payee, fee or tax economics separately");
+                            const economics = lowerEconomics(feeEconomics ? feeEconomics.get("payee") : economicsExpr);
                             if (op === "internal_transfer.create" ||
                                 op === "internal_transfer.reserve") {
                                 const amount = parts.get("amount"), from = parts.get("from"), to = parts.get("to");
@@ -1738,6 +1809,7 @@ export function compile(source, options = {}) {
                                         a.moves.push({
                                             key: `${key}_${index + 1}`,
                                             operation: "internal_transfer.create",
+                                            ...(economics ? { economics } : {}),
                                             amount: piece,
                                             from: path(from),
                                             to: `party.${recipient.value}`,
@@ -1752,6 +1824,7 @@ export function compile(source, options = {}) {
                                 const transfer = {
                                     key,
                                     operation: op,
+                                    ...(economics ? { economics } : {}),
                                     ...(parts.has("capture")
                                         ? { capture: String(data(parts.get("capture"))) }
                                         : {}),
@@ -1851,6 +1924,9 @@ export function compile(source, options = {}) {
                                     });
                                     a.moves.push({
                                         key: key + "Fee",
+                                        ...(feeEconomics?.has("fee")
+                                            ? { economics: lowerEconomics(feeEconomics.get("fee")) }
+                                            : {}),
                                         operation: "internal_transfer.create",
                                         amount: charge,
                                         from: transfer.from,
@@ -1859,6 +1935,9 @@ export function compile(source, options = {}) {
                                     if (vat)
                                         a.moves.push({
                                             key: key + "Tax",
+                                            ...(feeEconomics?.has("tax")
+                                                ? { economics: lowerEconomics(feeEconomics.get("tax")) }
+                                                : {}),
                                             operation: "internal_transfer.create",
                                             amount: vat,
                                             from: transfer.from,
@@ -1871,6 +1950,7 @@ export function compile(source, options = {}) {
                                 a.moves.push({
                                     key,
                                     operation: op,
+                                    ...(economics ? { economics } : {}),
                                     transfer: path(parts.get("transfer")),
                                     ...(parts.has("capture")
                                         ? { capture: String(data(parts.get("capture"))) }