@fairmint/canton-node-sdk 0.0.258 → 0.0.260

package/build/src/utils/token-standard/v1/constants.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Interface ids and choice names of the CIP-56 token standard V1 APIs.
+ *
+ * A standard choice is exercised against the _interface_ id rather than the template id, because that is the contract
+ * the choice is defined on. The interface ids are package-name scoped (`#package-name:Module:Interface`), which is what
+ * keeps them stable across DAR upgrades.
+ */
+export declare const TOKEN_STANDARD_V1_HOLDING_INTERFACE_ID = "#splice-api-token-holding-v1:Splice.Api.Token.HoldingV1:Holding";
+/** Exercise target for `BurnMintFactory_BurnMint`, which every mint, burn and redeem goes through. */
+export declare const TOKEN_STANDARD_V1_BURN_MINT_FACTORY_INTERFACE_ID = "#splice-api-token-burn-mint-v1:Splice.Api.Token.BurnMintV1:BurnMintFactory";
+/** Exercise target for `TransferFactory_Transfer`. */
+export declare const TOKEN_STANDARD_V1_TRANSFER_FACTORY_INTERFACE_ID = "#splice-api-token-transfer-instruction-v1:Splice.Api.Token.TransferInstructionV1:TransferFactory";
+/** Exercise target for the four choices on a pending transfer offer. */
+export declare const TOKEN_STANDARD_V1_TRANSFER_INSTRUCTION_INTERFACE_ID = "#splice-api-token-transfer-instruction-v1:Splice.Api.Token.TransferInstructionV1:TransferInstruction";
+/** Exercise target for `AllocationFactory_Allocate`. */
+export declare const TOKEN_STANDARD_V1_ALLOCATION_FACTORY_INTERFACE_ID = "#splice-api-token-allocation-instruction-v1:Splice.Api.Token.AllocationInstructionV1:AllocationFactory";
+/** Exercise target for the three choices on a settled or unwinding allocation. */
+export declare const TOKEN_STANDARD_V1_ALLOCATION_INTERFACE_ID = "#splice-api-token-allocation-v1:Splice.Api.Token.AllocationV1:Allocation";
+/** Choice names as the Ledger JSON API spells them in an `ExerciseCommand`. */
+export declare const TokenStandardV1Choice: {
+    readonly burnMint: 'BurnMintFactory_BurnMint';
+    readonly transfer: 'TransferFactory_Transfer';
+    readonly transferInstructionAccept: 'TransferInstruction_Accept';
+    readonly transferInstructionReject: 'TransferInstruction_Reject';
+    readonly transferInstructionWithdraw: 'TransferInstruction_Withdraw';
+    readonly transferInstructionUpdate: 'TransferInstruction_Update';
+    readonly allocate: 'AllocationFactory_Allocate';
+    readonly allocationExecuteTransfer: 'Allocation_ExecuteTransfer';
+    readonly allocationCancel: 'Allocation_Cancel';
+    readonly allocationWithdraw: 'Allocation_Withdraw';
+};
+export type TokenStandardV1ChoiceName = (typeof TokenStandardV1Choice)[keyof typeof TokenStandardV1Choice];
+/**
+ * The five choices that return a `TransferInstructionResult`. One reader covers instructing, accepting, rejecting,
+ * withdrawing and expiring, because all five return the same record.
+ */
+export declare const TOKEN_STANDARD_V1_TRANSFER_RESULT_CHOICES: readonly string[];
+/** The three `TransferInstructionResult.output` variants the standard defines. */
+export declare const TokenStandardV1TransferResultTag: {
+    readonly completed: 'TransferInstructionResult_Completed';
+    readonly pending: 'TransferInstructionResult_Pending';
+    readonly failed: 'TransferInstructionResult_Failed';
+};
+export declare const TOKEN_STANDARD_V1_TRANSFER_RESULT_TAGS: readonly string[];
+/** The three `AllocationInstructionResult.output` variants the standard defines. */
+export declare const TokenStandardV1AllocationResultTag: {
+    readonly completed: 'AllocationInstructionResult_Completed';
+    readonly pending: 'AllocationInstructionResult_Pending';
+    readonly failed: 'AllocationInstructionResult_Failed';
+};
+export declare const TOKEN_STANDARD_V1_ALLOCATION_RESULT_TAGS: readonly string[];
+/** The three exits an allocation has, all returning holdings; the difference is who gets them. */
+export declare const TOKEN_STANDARD_V1_ALLOCATION_EXIT_CHOICES: readonly string[];
+//# sourceMappingURL=constants.d.ts.map

package/build/src/utils/token-standard/v1/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/constants.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,sCAAsC,oEAAoE,CAAC;AAExH,sGAAsG;AACtG,eAAO,MAAM,gDAAgD,+EACiB,CAAC;AAE/E,sDAAsD;AACtD,eAAO,MAAM,+CAA+C,qGACwC,CAAC;AAErG,wEAAwE;AACxE,eAAO,MAAM,mDAAmD,yGACwC,CAAC;AAEzG,wDAAwD;AACxD,eAAO,MAAM,iDAAiD,2GAC4C,CAAC;AAE3G,kFAAkF;AAClF,eAAO,MAAM,yCAAyC,6EACsB,CAAC;AAE7E,+EAA+E;AAC/E,eAAO,MAAM,qBAAqB;aAChC,QAAQ,EAAE,0BAA0B;aACpC,QAAQ,EAAE,0BAA0B;aACpC,yBAAyB,EAAE,4BAA4B;aACvD,yBAAyB,EAAE,4BAA4B;aACvD,2BAA2B,EAAE,8BAA8B;aAC3D,yBAAyB,EAAE,4BAA4B;aACvD,QAAQ,EAAE,4BAA4B;aACtC,yBAAyB,EAAE,4BAA4B;aACvD,gBAAgB,EAAE,mBAAmB;aACrC,kBAAkB,EAAE,qBAAqB;CACjC,CAAC;AAEX,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAE3G;;;GAGG;AACH,eAAO,MAAM,yCAAyC,EAAE,SAAS,MAAM,EAMtE,CAAC;AAEF,kFAAkF;AAClF,eAAO,MAAM,gCAAgC;aAC3C,SAAS,EAAE,qCAAqC;aAChD,OAAO,EAAE,mCAAmC;aAC5C,MAAM,EAAE,kCAAkC;CAClC,CAAC;AAEX,eAAO,MAAM,sCAAsC,EAAE,SAAS,MAAM,EAEnE,CAAC;AAEF,oFAAoF;AACpF,eAAO,MAAM,kCAAkC;aAC7C,SAAS,EAAE,uCAAuC;aAClD,OAAO,EAAE,qCAAqC;aAC9C,MAAM,EAAE,oCAAoC;CACpC,CAAC;AAEX,eAAO,MAAM,wCAAwC,EAAE,SAAS,MAAM,EAErE,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,yCAAyC,EAAE,SAAS,MAAM,EAItE,CAAC"}

package/build/src/utils/token-standard/v1/constants.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * Interface ids and choice names of the CIP-56 token standard V1 APIs.
+ *
+ * A standard choice is exercised against the _interface_ id rather than the template id, because that is the contract
+ * the choice is defined on. The interface ids are package-name scoped (`#package-name:Module:Interface`), which is what
+ * keeps them stable across DAR upgrades.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOKEN_STANDARD_V1_ALLOCATION_EXIT_CHOICES = exports.TOKEN_STANDARD_V1_ALLOCATION_RESULT_TAGS = exports.TokenStandardV1AllocationResultTag = exports.TOKEN_STANDARD_V1_TRANSFER_RESULT_TAGS = exports.TokenStandardV1TransferResultTag = exports.TOKEN_STANDARD_V1_TRANSFER_RESULT_CHOICES = exports.TokenStandardV1Choice = exports.TOKEN_STANDARD_V1_ALLOCATION_INTERFACE_ID = exports.TOKEN_STANDARD_V1_ALLOCATION_FACTORY_INTERFACE_ID = exports.TOKEN_STANDARD_V1_TRANSFER_INSTRUCTION_INTERFACE_ID = exports.TOKEN_STANDARD_V1_TRANSFER_FACTORY_INTERFACE_ID = exports.TOKEN_STANDARD_V1_BURN_MINT_FACTORY_INTERFACE_ID = exports.TOKEN_STANDARD_V1_HOLDING_INTERFACE_ID = void 0;
+exports.TOKEN_STANDARD_V1_HOLDING_INTERFACE_ID = '#splice-api-token-holding-v1:Splice.Api.Token.HoldingV1:Holding';
+/** Exercise target for `BurnMintFactory_BurnMint`, which every mint, burn and redeem goes through. */
+exports.TOKEN_STANDARD_V1_BURN_MINT_FACTORY_INTERFACE_ID = '#splice-api-token-burn-mint-v1:Splice.Api.Token.BurnMintV1:BurnMintFactory';
+/** Exercise target for `TransferFactory_Transfer`. */
+exports.TOKEN_STANDARD_V1_TRANSFER_FACTORY_INTERFACE_ID = '#splice-api-token-transfer-instruction-v1:Splice.Api.Token.TransferInstructionV1:TransferFactory';
+/** Exercise target for the four choices on a pending transfer offer. */
+exports.TOKEN_STANDARD_V1_TRANSFER_INSTRUCTION_INTERFACE_ID = '#splice-api-token-transfer-instruction-v1:Splice.Api.Token.TransferInstructionV1:TransferInstruction';
+/** Exercise target for `AllocationFactory_Allocate`. */
+exports.TOKEN_STANDARD_V1_ALLOCATION_FACTORY_INTERFACE_ID = '#splice-api-token-allocation-instruction-v1:Splice.Api.Token.AllocationInstructionV1:AllocationFactory';
+/** Exercise target for the three choices on a settled or unwinding allocation. */
+exports.TOKEN_STANDARD_V1_ALLOCATION_INTERFACE_ID = '#splice-api-token-allocation-v1:Splice.Api.Token.AllocationV1:Allocation';
+/** Choice names as the Ledger JSON API spells them in an `ExerciseCommand`. */
+exports.TokenStandardV1Choice = {
+    burnMint: 'BurnMintFactory_BurnMint',
+    transfer: 'TransferFactory_Transfer',
+    transferInstructionAccept: 'TransferInstruction_Accept',
+    transferInstructionReject: 'TransferInstruction_Reject',
+    transferInstructionWithdraw: 'TransferInstruction_Withdraw',
+    transferInstructionUpdate: 'TransferInstruction_Update',
+    allocate: 'AllocationFactory_Allocate',
+    allocationExecuteTransfer: 'Allocation_ExecuteTransfer',
+    allocationCancel: 'Allocation_Cancel',
+    allocationWithdraw: 'Allocation_Withdraw',
+};
+/**
+ * The five choices that return a `TransferInstructionResult`. One reader covers instructing, accepting, rejecting,
+ * withdrawing and expiring, because all five return the same record.
+ */
+exports.TOKEN_STANDARD_V1_TRANSFER_RESULT_CHOICES = [
+    exports.TokenStandardV1Choice.transfer,
+    exports.TokenStandardV1Choice.transferInstructionAccept,
+    exports.TokenStandardV1Choice.transferInstructionReject,
+    exports.TokenStandardV1Choice.transferInstructionWithdraw,
+    exports.TokenStandardV1Choice.transferInstructionUpdate,
+];
+/** The three `TransferInstructionResult.output` variants the standard defines. */
+exports.TokenStandardV1TransferResultTag = {
+    completed: 'TransferInstructionResult_Completed',
+    pending: 'TransferInstructionResult_Pending',
+    failed: 'TransferInstructionResult_Failed',
+};
+exports.TOKEN_STANDARD_V1_TRANSFER_RESULT_TAGS = Object.values(exports.TokenStandardV1TransferResultTag);
+/** The three `AllocationInstructionResult.output` variants the standard defines. */
+exports.TokenStandardV1AllocationResultTag = {
+    completed: 'AllocationInstructionResult_Completed',
+    pending: 'AllocationInstructionResult_Pending',
+    failed: 'AllocationInstructionResult_Failed',
+};
+exports.TOKEN_STANDARD_V1_ALLOCATION_RESULT_TAGS = Object.values(exports.TokenStandardV1AllocationResultTag);
+/** The three exits an allocation has, all returning holdings; the difference is who gets them. */
+exports.TOKEN_STANDARD_V1_ALLOCATION_EXIT_CHOICES = [
+    exports.TokenStandardV1Choice.allocationExecuteTransfer,
+    exports.TokenStandardV1Choice.allocationCancel,
+    exports.TokenStandardV1Choice.allocationWithdraw,
+];
+//# sourceMappingURL=constants.js.map

package/build/src/utils/token-standard/v1/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/constants.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEU,QAAA,sCAAsC,GAAG,iEAAiE,CAAC;AAExH,sGAAsG;AACzF,QAAA,gDAAgD,GAC3D,4EAA4E,CAAC;AAE/E,sDAAsD;AACzC,QAAA,+CAA+C,GAC1D,kGAAkG,CAAC;AAErG,wEAAwE;AAC3D,QAAA,mDAAmD,GAC9D,sGAAsG,CAAC;AAEzG,wDAAwD;AAC3C,QAAA,iDAAiD,GAC5D,wGAAwG,CAAC;AAE3G,kFAAkF;AACrE,QAAA,yCAAyC,GACpD,0EAA0E,CAAC;AAE7E,+EAA+E;AAClE,QAAA,qBAAqB,GAAG;IACnC,QAAQ,EAAE,0BAA0B;IACpC,QAAQ,EAAE,0BAA0B;IACpC,yBAAyB,EAAE,4BAA4B;IACvD,yBAAyB,EAAE,4BAA4B;IACvD,2BAA2B,EAAE,8BAA8B;IAC3D,yBAAyB,EAAE,4BAA4B;IACvD,QAAQ,EAAE,4BAA4B;IACtC,yBAAyB,EAAE,4BAA4B;IACvD,gBAAgB,EAAE,mBAAmB;IACrC,kBAAkB,EAAE,qBAAqB;CACjC,CAAC;AAIX;;;GAGG;AACU,QAAA,yCAAyC,GAAsB;IAC1E,QAAA,qBAAqB,CAAC,QAAQ;IAC9B,QAAA,qBAAqB,CAAC,yBAAyB;IAC/C,QAAA,qBAAqB,CAAC,yBAAyB;IAC/C,QAAA,qBAAqB,CAAC,2BAA2B;IACjD,QAAA,qBAAqB,CAAC,yBAAyB;CAChD,CAAC;AAEF,kFAAkF;AACrE,QAAA,gCAAgC,GAAG;IAC9C,SAAS,EAAE,qCAAqC;IAChD,OAAO,EAAE,mCAAmC;IAC5C,MAAM,EAAE,kCAAkC;CAClC,CAAC;AAEE,QAAA,sCAAsC,GAAsB,MAAM,CAAC,MAAM,CACpF,QAAA,gCAAgC,CACjC,CAAC;AAEF,oFAAoF;AACvE,QAAA,kCAAkC,GAAG;IAChD,SAAS,EAAE,uCAAuC;IAClD,OAAO,EAAE,qCAAqC;IAC9C,MAAM,EAAE,oCAAoC;CACpC,CAAC;AAEE,QAAA,wCAAwC,GAAsB,MAAM,CAAC,MAAM,CACtF,QAAA,kCAAkC,CACnC,CAAC;AAEF,kGAAkG;AACrF,QAAA,yCAAyC,GAAsB;IAC1E,QAAA,qBAAqB,CAAC,yBAAyB;IAC/C,QAAA,qBAAqB,CAAC,gBAAgB;IACtC,QAAA,qBAAqB,CAAC,kBAAkB;CACzC,CAAC"}

package/build/src/utils/token-standard/v1/errors.d.ts

@@ -0,0 +1,12 @@
+import { CantonError, type ErrorContext } from '../../../core/errors';
+export declare const TokenStandardV1ResultErrorCode: {
+    readonly RESULT_NOT_FOUND: 'TOKEN_STANDARD_V1_RESULT_NOT_FOUND';
+    readonly RESULT_INVALID: 'TOKEN_STANDARD_V1_RESULT_INVALID';
+};
+export type TokenStandardV1ResultErrorCode = (typeof TokenStandardV1ResultErrorCode)[keyof typeof TokenStandardV1ResultErrorCode];
+/** Thrown when a transaction does not contain the token standard V1 result a reader was asked for, or it is malformed. */
+export declare class TokenStandardV1ResultError extends CantonError {
+    readonly name: string;
+    constructor(code: TokenStandardV1ResultErrorCode, message: string, context?: ErrorContext);
+}
+//# sourceMappingURL=errors.d.ts.map

package/build/src/utils/token-standard/v1/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEtE,eAAO,MAAM,8BAA8B;aACzC,gBAAgB,EAAE,oCAAoC;aACtD,cAAc,EAAE,kCAAkC;CAC1C,CAAC;AAEX,MAAM,MAAM,8BAA8B,GACxC,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,OAAO,8BAA8B,CAAC,CAAC;AAEvF,0HAA0H;AAC1H,qBAAa,0BAA2B,SAAQ,WAAW;IACzD,SAAyB,IAAI,EAAE,MAAM,CAAC;IAEtC,YAAmB,IAAI,EAAE,8BAA8B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAG/F;CACF"}

package/build/src/utils/token-standard/v1/errors.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenStandardV1ResultError = exports.TokenStandardV1ResultErrorCode = void 0;
+const errors_1 = require("../../../core/errors");
+exports.TokenStandardV1ResultErrorCode = {
+    RESULT_NOT_FOUND: 'TOKEN_STANDARD_V1_RESULT_NOT_FOUND',
+    RESULT_INVALID: 'TOKEN_STANDARD_V1_RESULT_INVALID',
+};
+/** Thrown when a transaction does not contain the token standard V1 result a reader was asked for, or it is malformed. */
+class TokenStandardV1ResultError extends errors_1.CantonError {
+    constructor(code, message, context) {
+        super(message, code, context);
+        this.name = 'TokenStandardV1ResultError';
+    }
+}
+exports.TokenStandardV1ResultError = TokenStandardV1ResultError;
+//# sourceMappingURL=errors.js.map

package/build/src/utils/token-standard/v1/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/errors.ts"],"names":[],"mappings":";;;AAAA,iDAAsE;AAEzD,QAAA,8BAA8B,GAAG;IAC5C,gBAAgB,EAAE,oCAAoC;IACtD,cAAc,EAAE,kCAAkC;CAC1C,CAAC;AAKX,0HAA0H;AAC1H,gCAAwC,SAAQ,oBAAW;IAGzD,YAAmB,IAAoC,EAAE,OAAe,EAAE,OAAsB;QAC9F,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAC;IAC3C,CAAC;CACF"}

package/build/src/utils/token-standard/v1/index.d.ts

@@ -0,0 +1,7 @@
+export * from './allocation';
+export * from './burn-mint';
+export * from './constants';
+export * from './errors';
+export * from './result';
+export * from './transfer';
+//# sourceMappingURL=index.d.ts.map

package/build/src/utils/token-standard/v1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}

package/build/src/utils/token-standard/v1/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./allocation"), exports);
+__exportStar(require("./burn-mint"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./result"), exports);
+__exportStar(require("./transfer"), exports);
+//# sourceMappingURL=index.js.map

package/build/src/utils/token-standard/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8CAA4B;AAC5B,8CAA4B;AAC5B,2CAAyB;AACzB,2CAAyB;AACzB,6CAA2B"}

package/build/src/utils/token-standard/v1/result.d.ts

@@ -0,0 +1,27 @@
+/** The record a standard choice returned, or a failure: a caller asking for it asserts the transaction contains it. */
+export declare function requireResultRecord(transaction: unknown, choice: string): Record<string, unknown>;
+/** The record returned by the first of `choices` this transaction exercised. */
+export declare function requireResultRecordOfAny(transaction: unknown, choices: readonly string[]): Record<string, unknown>;
+/** A required non-empty string from a result record. */
+export declare function requireNonEmptyString(value: unknown, field: string): string;
+/** A required list of contract ids from a result record. */
+export declare function requireContractIds(value: unknown, field: string): string[];
+/** An optional list of contract ids, which the token standard omits rather than sending empty on some paths. */
+export declare function readContractIds(value: unknown, field: string): string[];
+/** `{ tag, value }`, the Daml JSON encoding of a variant. */
+export declare function readVariant(value: unknown): {
+    readonly tag: string;
+    readonly value: Record<string, unknown>;
+} | undefined;
+/**
+ * A variant field of a result record, which must be one of the variants the reader knows.
+ *
+ * A missing field or an unrecognized tag is reported rather than folded into the nearest status. The standard's
+ * `_Failed` output means the units went back to the sender, so answering an unknown tag with it would tell a caller a
+ * transfer was returned when nothing here knows what happened to it.
+ */
+export declare function requireKnownVariant(result: Record<string, unknown>, field: string, known: readonly string[], what: string): {
+    readonly tag: string;
+    readonly value: Record<string, unknown>;
+};
+//# sourceMappingURL=result.d.ts.map

package/build/src/utils/token-standard/v1/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/result.ts"],"names":[],"mappings":"AAIA,uHAAuH;AACvH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEjG;AAED,gFAAgF;AAChF,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAiBlH;AAED,wDAAwD;AACxD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAS3E;AAED,4DAA4D;AAC5D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAoB1E;AAED,gHAAgH;AAChH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAKvE;AAED,6DAA6D;AAC7D,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,GACb;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG,SAAS,CAG/E;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,IAAI,EAAE,MAAM,GACX;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAiBnE"}

package/build/src/utils/token-standard/v1/result.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireResultRecord = requireResultRecord;
+exports.requireResultRecordOfAny = requireResultRecordOfAny;
+exports.requireNonEmptyString = requireNonEmptyString;
+exports.requireContractIds = requireContractIds;
+exports.readContractIds = readContractIds;
+exports.readVariant = readVariant;
+exports.requireKnownVariant = requireKnownVariant;
+const utils_1 = require("../../../core/utils");
+const event_parser_1 = require("../../parsers/event-parser");
+const errors_1 = require("./errors");
+/** The record a standard choice returned, or a failure: a caller asking for it asserts the transaction contains it. */
+function requireResultRecord(transaction, choice) {
+    return requireResultRecordOfAny(transaction, [choice]);
+}
+/** The record returned by the first of `choices` this transaction exercised. */
+function requireResultRecordOfAny(transaction, choices) {
+    const exercised = (0, event_parser_1.findExercisedEvent)(transaction, choices);
+    if (!exercised) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_NOT_FOUND, `The transaction contains none of these exercises: ${choices.join(', ')}.`, { choices: [...choices], updateId: (0, event_parser_1.getTransactionUpdateId)(transaction) });
+    }
+    if (!(0, utils_1.isRecord)(exercised.exerciseResult)) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `The ${exercised.choice} exercise returned no result record.`, { choice: exercised.choice, updateId: (0, event_parser_1.getTransactionUpdateId)(transaction) });
+    }
+    return exercised.exerciseResult;
+}
+/** A required non-empty string from a result record. */
+function requireNonEmptyString(value, field) {
+    if (typeof value !== 'string' || value.length === 0) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `The exercise result has no ${field}.`, { field });
+    }
+    return value;
+}
+/** A required list of contract ids from a result record. */
+function requireContractIds(value, field) {
+    if (!Array.isArray(value)) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `The exercise result has no ${field}.`, { field });
+    }
+    const contractIds = [];
+    for (const entry of value) {
+        if (typeof entry !== 'string' || entry.length === 0) {
+            throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `The ${field} is not a list of contract ids.`, { field });
+        }
+        contractIds.push(entry);
+    }
+    return contractIds;
+}
+/** An optional list of contract ids, which the token standard omits rather than sending empty on some paths. */
+function readContractIds(value, field) {
+    if (!Array.isArray(value)) {
+        return [];
+    }
+    return requireContractIds(value, field);
+}
+/** `{ tag, value }`, the Daml JSON encoding of a variant. */
+function readVariant(value) {
+    if (!(0, utils_1.isRecord)(value) || typeof value['tag'] !== 'string')
+        return undefined;
+    return { tag: value['tag'], value: (0, utils_1.isRecord)(value['value']) ? value['value'] : {} };
+}
+/**
+ * A variant field of a result record, which must be one of the variants the reader knows.
+ *
+ * A missing field or an unrecognized tag is reported rather than folded into the nearest status. The standard's
+ * `_Failed` output means the units went back to the sender, so answering an unknown tag with it would tell a caller a
+ * transfer was returned when nothing here knows what happened to it.
+ */
+function requireKnownVariant(result, field, known, what) {
+    const variant = readVariant(result[field]);
+    if (!variant) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `The ${what} names no ${field}.`, { field });
+    }
+    if (!known.includes(variant.tag)) {
+        throw new errors_1.TokenStandardV1ResultError(errors_1.TokenStandardV1ResultErrorCode.RESULT_INVALID, `Unknown ${what} ${field}: ${variant.tag}.`, { field, tag: variant.tag, known: [...known] });
+    }
+    return variant;
+}
+//# sourceMappingURL=result.js.map

package/build/src/utils/token-standard/v1/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/result.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAA+C;AAC/C,6DAAwF;AACxF,qCAAsF;AAEtF,uHAAuH;AACvH,6BAAoC,WAAoB,EAAE,MAAc;IACtE,OAAO,wBAAwB,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,gFAAgF;AAChF,kCAAyC,WAAoB,EAAE,OAA0B;IACvF,MAAM,SAAS,GAAG,IAAA,iCAAkB,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,gBAAgB,EAC/C,qDAAqD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAC1E,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAA,qCAAsB,EAAC,WAAW,CAAC,EAAE,CACzE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,IAAA,gBAAQ,EAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,OAAO,SAAS,CAAC,MAAM,sCAAsC,EAC7D,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAA,qCAAsB,EAAC,WAAW,CAAC,EAAE,CAC5E,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC,cAAc,CAAC;AAClC,CAAC;AAED,wDAAwD;AACxD,+BAAsC,KAAc,EAAE,KAAa;IACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,8BAA8B,KAAK,GAAG,EACtC,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,4DAA4D;AAC5D,4BAAmC,KAAc,EAAE,KAAa;IAC9D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,8BAA8B,KAAK,GAAG,EACtC,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IACD,MAAM,WAAW,GAAa,EAAE,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,OAAO,KAAK,iCAAiC,EAC7C,EAAE,KAAK,EAAE,CACV,CAAC;QACJ,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,gHAAgH;AAChH,yBAAgC,KAAc,EAAE,KAAa;IAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,6DAA6D;AAC7D,qBACE,KAAc;IAEd,IAAI,CAAC,IAAA,gBAAQ,EAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC3E,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAA,gBAAQ,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACtF,CAAC;AAED;;;;;;GAMG;AACH,6BACE,MAA+B,EAC/B,KAAa,EACb,KAAwB,EACxB,IAAY;IAEZ,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,OAAO,IAAI,aAAa,KAAK,GAAG,EAChC,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,mCAA0B,CAClC,uCAA8B,CAAC,cAAc,EAC7C,WAAW,IAAI,IAAI,KAAK,KAAK,OAAO,CAAC,GAAG,GAAG,EAC3C,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAC/C,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/build/src/utils/token-standard/v1/transfer.d.ts

@@ -0,0 +1,27 @@
+/**
+ * What became of a transfer: delivered, waiting on the receiver, or returned to the sender.
+ *
+ * `TransferInstructionResult.output` is the only thing that says which, and all five transfer choices return it, so one
+ * reader covers instructing, accepting, rejecting, withdrawing and expiring.
+ */
+/** What became of the units: delivered, waiting on the receiver, or returned to the sender. */
+export type TokenStandardV1TransferStatus = 'completed' | 'pending' | 'failed';
+export interface TokenStandardV1TransferResult {
+    readonly updateId: string;
+    readonly status: TokenStandardV1TransferStatus;
+    /** Change back to the sender, and on a failed path the returned units themselves. */
+    readonly senderChangeCids: string[];
+    /** The receiver's new holdings, on a completed transfer. */
+    readonly receiverHoldingCids: string[];
+    /** The pending offer, when the transfer did not complete in this transaction. */
+    readonly transferInstructionCid: string | undefined;
+}
+/**
+ * The `TransferInstructionResult` of whichever of the five transfer choices this transaction exercised.
+ *
+ * `failed` is reported only for the standard's `_Failed` output, which says the units went back to the sender. An
+ * output the standard does not define, or a result naming none at all, is a failure to read the transaction rather than
+ * a transfer that failed.
+ */
+export declare function parseTransferResult(transaction: unknown): TokenStandardV1TransferResult;
+//# sourceMappingURL=transfer.d.ts.map

package/build/src/utils/token-standard/v1/transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/transfer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH,+FAA+F;AAC/F,MAAM,MAAM,6BAA6B,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE/E,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,6BAA6B,CAAC;IAC/C,qFAAqF;IACrF,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IACpC,4DAA4D;IAC5D,QAAQ,CAAC,mBAAmB,EAAE,MAAM,EAAE,CAAC;IACvC,iFAAiF;IACjF,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC;CACrD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,OAAO,GAAG,6BAA6B,CAiCvF"}

package/build/src/utils/token-standard/v1/transfer.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * What became of a transfer: delivered, waiting on the receiver, or returned to the sender.
+ *
+ * `TransferInstructionResult.output` is the only thing that says which, and all five transfer choices return it, so one
+ * reader covers instructing, accepting, rejecting, withdrawing and expiring.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTransferResult = parseTransferResult;
+const event_parser_1 = require("../../parsers/event-parser");
+const constants_1 = require("./constants");
+const result_1 = require("./result");
+/**
+ * The `TransferInstructionResult` of whichever of the five transfer choices this transaction exercised.
+ *
+ * `failed` is reported only for the standard's `_Failed` output, which says the units went back to the sender. An
+ * output the standard does not define, or a result naming none at all, is a failure to read the transaction rather than
+ * a transfer that failed.
+ */
+function parseTransferResult(transaction) {
+    const result = (0, result_1.requireResultRecordOfAny)(transaction, constants_1.TOKEN_STANDARD_V1_TRANSFER_RESULT_CHOICES);
+    const updateId = (0, event_parser_1.requireTransactionUpdateId)(transaction);
+    const senderChangeCids = (0, result_1.requireContractIds)(result['senderChangeCids'], 'senderChangeCids');
+    const output = (0, result_1.requireKnownVariant)(result, 'output', constants_1.TOKEN_STANDARD_V1_TRANSFER_RESULT_TAGS, 'transfer result');
+    if (output.tag === constants_1.TokenStandardV1TransferResultTag.completed) {
+        return {
+            updateId,
+            status: 'completed',
+            senderChangeCids,
+            receiverHoldingCids: (0, result_1.requireContractIds)(output.value['receiverHoldingCids'], 'receiverHoldingCids'),
+            transferInstructionCid: undefined,
+        };
+    }
+    if (output.tag === constants_1.TokenStandardV1TransferResultTag.pending) {
+        return {
+            updateId,
+            status: 'pending',
+            senderChangeCids,
+            receiverHoldingCids: [],
+            transferInstructionCid: (0, result_1.requireNonEmptyString)(output.value['transferInstructionCid'], 'transferInstructionCid'),
+        };
+    }
+    return {
+        updateId,
+        status: 'failed',
+        senderChangeCids,
+        receiverHoldingCids: [],
+        transferInstructionCid: undefined,
+    };
+}
+//# sourceMappingURL=transfer.js.map

package/build/src/utils/token-standard/v1/transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.js","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v1/transfer.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6DAAwE;AACxE,2CAIqB;AACrB,qCAAoH;AAgBpH;;;;;;GAMG;AACH,6BAAoC,WAAoB;IACtD,MAAM,MAAM,GAAG,IAAA,iCAAwB,EAAC,WAAW,EAAE,qDAAyC,CAAC,CAAC;IAChG,MAAM,QAAQ,GAAG,IAAA,yCAA0B,EAAC,WAAW,CAAC,CAAC;IACzD,MAAM,gBAAgB,GAAG,IAAA,2BAAkB,EAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC,CAAC;IAC5F,MAAM,MAAM,GAAG,IAAA,4BAAmB,EAAC,MAAM,EAAE,QAAQ,EAAE,kDAAsC,EAAE,iBAAiB,CAAC,CAAC;IAEhH,IAAI,MAAM,CAAC,GAAG,KAAK,4CAAgC,CAAC,SAAS,EAAE,CAAC;QAC9D,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,WAAW;YACnB,gBAAgB;YAChB,mBAAmB,EAAE,IAAA,2BAAkB,EAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;YACnG,sBAAsB,EAAE,SAAS;SAClC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,GAAG,KAAK,4CAAgC,CAAC,OAAO,EAAE,CAAC;QAC5D,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,SAAS;YACjB,gBAAgB;YAChB,mBAAmB,EAAE,EAAE;YACvB,sBAAsB,EAAE,IAAA,8BAAqB,EAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;SAChH,CAAC;IACJ,CAAC;IAED,OAAO;QACL,QAAQ;QACR,MAAM,EAAE,QAAQ;QAChB,gBAAgB;QAChB,mBAAmB,EAAE,EAAE;QACvB,sBAAsB,EAAE,SAAS;KAClC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairmint/canton-node-sdk",
-  "version": "0.0.258",
+  "version": "0.0.260",
   "description": "Canton Node SDK",
   "keywords": [
     "canton",