@hyperscale0/hsx 5.4.2 → 5.6.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# HSX 5.6.0
+
+The compiler records the standard block origin of every instrument compiled
+from a bundled std header: block key, record path and header digest. Travel
+booking cancellations declare `purpose: option`. Follows UDL 4.8.0.
+
+# 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.

package/dist/src/compile.d.ts

@@ -15,6 +15,11 @@ export interface CompileOriginMapEntry {
         line: number;
         column: number;
     };
+    standardBlock?: {
+        key: string;
+        recordPath: string;
+        headerDigest: string;
+    };
 }
 export interface AdapterBindingTarget {
     adapter: ProviderAdapter;

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;IAC9C,aAAa,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3E;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,CAktGf"}

package/dist/src/compile.js

@@ -277,6 +277,7 @@ export function compile(source, options = {}) {
             fail(program, "this release supports SAR", "write currency SAR or omit currency");
         const templates = new Map();
         const declarationSources = new Map();
+        const standardOrigins = new Map();
         const requirementOrigins = new Map();
         const used = new Set();
         for (const use of program.decls.filter((d) => d.kind === "use")) {
@@ -287,6 +288,10 @@ export function compile(source, options = {}) {
             if (!content)
                 fail(use, `unknown header ${use.name}`, "choose a published header");
             sources.set(use.name, content);
+            const bundled = bundledStandardLibrary.source(use.name);
+            const headerDigest = bundled === content
+                ? Array.from(sha256(new TextEncoder().encode(content)), (byte) => byte.toString(16).padStart(2, "0")).join("")
+                : undefined;
             let header;
             try {
                 header = parseHeader(content, use.name);
@@ -310,6 +315,14 @@ export function compile(source, options = {}) {
                     fail(parentDecl, `duplicate instrument ${prefix}`, "give each instrument a distinct name");
                 templates.set(prefix, parentDecl);
                 declarationSources.set(parentDecl, use.name);
+                if (headerDigest) {
+                    const [, root, ...record] = prefix.split(".");
+                    standardOrigins.set(parentDecl, {
+                        key: `${use.name}.${root}`,
+                        recordPath: record.join("."),
+                        headerDigest,
+                    });
+                }
                 const recs = entries(asBlock(entries(parentDecl.body).get("records")));
                 for (const [recName, recBlock] of recs) {
                     const recDecl = {
@@ -441,7 +454,7 @@ export function compile(source, options = {}) {
             }
             return { module: moduleName, exportPath, revision };
         };
-        const addInstrument = (decl, id, arguments_, origin, inherited = new Map(), inheritedEnums = new Map(), attachmentInfo, familyDeclaration) => {
+        const addInstrument = (decl, id, arguments_, origin, inherited = new Map(), inheritedEnums = new Map(), attachmentInfo, familyDeclaration, standardOrigin) => {
             const resolveFamilyInstruments = (family, currentInstId, expr) => {
                 const found = new Set();
                 if (currentInstId && familyDeclaration) {
@@ -1677,6 +1690,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 +1822,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 +1837,7 @@ export function compile(source, options = {}) {
                                 const transfer = {
                                     key,
                                     operation: op,
+                                    ...(economics ? { economics } : {}),
                                     ...(parts.has("capture")
                                         ? { capture: String(data(parts.get("capture"))) }
                                         : {}),
@@ -1851,6 +1937,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 +1948,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 +1963,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"))) }
@@ -1957,6 +2050,7 @@ export function compile(source, options = {}) {
             origins.push({
                 path: `$.instruments[${document.instruments.length}]`,
                 span: { ...origin, ...lineColAt(source, origin.start) },
+                ...(standardOrigin ? { standardBlock: standardOrigin } : {}),
             });
             if (familyDeclaration && familyDeclaration.revision !== undefined) {
                 inst.family = {
@@ -2002,7 +2096,14 @@ export function compile(source, options = {}) {
                 addInstrument(child, `${id}_${key}`, emptyBlock, origin, new Map([
                     ...environment,
                     ["parent", { kind: "name", value: id, span: origin }],
-                ]), enums, childAttachment, childFamily);
+                ]), enums, childAttachment, childFamily, standardOrigin
+                    ? {
+                        ...standardOrigin,
+                        recordPath: [standardOrigin.recordPath, key]
+                            .filter(Boolean)
+                            .join("."),
+                    }
+                    : undefined);
             }
         };
         const compileObject = (decl) => {
@@ -2090,7 +2191,7 @@ export function compile(source, options = {}) {
                         exposed,
                         parties,
                         attachments,
-                    }, templateFamily ? { ...templateFamily } : undefined);
+                    }, templateFamily ? { ...templateFamily } : undefined, standardOrigins.get(template));
                 }
                 catch (error) {
                     if (!(error instanceof CompileFailure))
@@ -2188,7 +2289,7 @@ export function compile(source, options = {}) {
                 if (!template)
                     fail(decl, `unknown instrument ${decl.target}`, `add use ${decl.target.split(".")[0]} and choose a declared instrument`);
                 const templateFamily = resolveFamily(decl.target, decl, false);
-                addInstrument(template, decl.name, decl.body, decl.span, new Map(), new Map(), undefined, templateFamily ? { ...templateFamily } : undefined);
+                addInstrument(template, decl.name, decl.body, decl.span, new Map(), new Map(), undefined, templateFamily ? { ...templateFamily } : undefined, standardOrigins.get(template));
             }
             if (decl.kind === "object") {
                 compileObject(decl);