@fairmint/canton-node-sdk 0.0.242 → 0.0.244

package/build/src/utils/token-standard/v2/allocation-state.d.ts

@@ -0,0 +1,104 @@
+import type { GetActiveContractsParams } from '../../../clients/ledger-json-api/operations/v2/state/get-active-contracts';
+import type { JsGetActiveContractsResponse } from '../../../clients/ledger-json-api/schemas';
+import { CantonError, type ErrorContext } from '../../../core/errors';
+import type { TokenStandardV2AllocationChoiceArgument } from './allocation';
+import type { TokenStandardV2Metadata } from './types';
+export declare const TOKEN_STANDARD_V2_ALLOCATION_INTERFACE_ID = "#splice-api-token-allocation-v2:Splice.Api.Token.AllocationV2:Allocation";
+export declare const TOKEN_STANDARD_V2_ALLOCATION_INSTRUCTION_INTERFACE_ID = "#splice-api-token-allocation-instruction-v2:Splice.Api.Token.AllocationInstructionV2:AllocationInstruction";
+export declare const TokenStandardV2AllocationStateErrorCode: {
+    readonly INPUT_INVALID: 'TOKEN_STANDARD_V2_ALLOCATION_STATE_INPUT_INVALID';
+    readonly INTERFACE_VIEW_INVALID: 'TOKEN_STANDARD_V2_ALLOCATION_STATE_INTERFACE_VIEW_INVALID';
+    readonly ACS_INCOMPLETE: 'TOKEN_STANDARD_V2_ALLOCATION_STATE_ACS_INCOMPLETE';
+    readonly AMBIGUOUS: 'TOKEN_STANDARD_V2_ALLOCATION_STATE_AMBIGUOUS';
+    readonly NOT_FOUND: 'TOKEN_STANDARD_V2_ALLOCATION_STATE_NOT_FOUND';
+};
+export type TokenStandardV2AllocationStateErrorCode = (typeof TokenStandardV2AllocationStateErrorCode)[keyof typeof TokenStandardV2AllocationStateErrorCode];
+/** Typed failure raised while recovering a Token Standard V2 allocation state from the ACS. */
+export declare class TokenStandardV2AllocationStateError extends CantonError {
+    readonly name: string;
+    constructor(code: TokenStandardV2AllocationStateErrorCode, message: string, context?: ErrorContext);
+}
+export interface TokenStandardV2AllocationStateClient {
+    getActiveContracts(params: GetActiveContractsParams): Promise<JsGetActiveContractsResponse>;
+}
+/** The request identity that remains observable through the Allocation and AllocationInstruction interfaces. */
+export interface TokenStandardV2AllocationStateRequest {
+    readonly settlement: TokenStandardV2AllocationChoiceArgument['settlement'];
+    readonly allocation: TokenStandardV2AllocationChoiceArgument['allocation'];
+    readonly requestedAt: string;
+    readonly inputHoldingCids: readonly string[];
+}
+export interface DiscoverTokenStandardV2AllocationStateParams {
+    readonly ledger: TokenStandardV2AllocationStateClient;
+    readonly parties: readonly string[];
+    readonly synchronizerId: string;
+    readonly request: TokenStandardV2AllocationStateRequest;
+    /** ACS snapshot offset. Requiring it keeps recovery to one Canton network read. */
+    readonly activeAtOffset: number;
+}
+export interface GetTokenStandardV2AllocationViewsByContractIdsParams {
+    readonly ledger: TokenStandardV2AllocationStateClient;
+    readonly parties: readonly string[];
+    readonly synchronizerId: string;
+    readonly allocationCids: readonly string[];
+    /** ACS snapshot offset. Requiring it binds every returned view to one Canton read. */
+    readonly activeAtOffset: number;
+}
+export interface TokenStandardV2AllocationView {
+    readonly originalAllocationCid: string | null;
+    readonly settlement: TokenStandardV2AllocationChoiceArgument['settlement'];
+    readonly allocation: TokenStandardV2AllocationChoiceArgument['allocation'];
+    readonly holdingCids: readonly string[];
+    readonly createdAt: string;
+    readonly numIterations: string;
+    readonly expiresAt: string | null;
+    readonly availableActions: unknown;
+    readonly meta: TokenStandardV2Metadata;
+}
+export interface TokenStandardV2AllocationInstructionView {
+    readonly originalInstructionCid: string | null;
+    readonly settlement: TokenStandardV2AllocationChoiceArgument['settlement'];
+    readonly allocation: TokenStandardV2AllocationChoiceArgument['allocation'];
+    readonly requestedAt: string;
+    readonly inputHoldingCids: readonly string[];
+    readonly expiresAt: string | null;
+    readonly availableActions: unknown;
+    readonly meta: TokenStandardV2Metadata;
+}
+export interface TokenStandardV2AllocationStateCompleted {
+    readonly type: 'Completed';
+    readonly allocationCid: string;
+    readonly view: TokenStandardV2AllocationView;
+}
+export interface TokenStandardV2AllocationContract {
+    readonly allocationCid: string;
+    readonly view: TokenStandardV2AllocationView;
+}
+export interface TokenStandardV2AllocationStatePending {
+    readonly type: 'Pending';
+    readonly allocationInstructionCid: string;
+    readonly view: TokenStandardV2AllocationInstructionView;
+}
+/**
+ * No matching active contract is visible. This does not imply failure: a Failed result can only be recovered from the
+ * original transaction tree or command completion, not from absence in the active contract set.
+ */
+export interface TokenStandardV2AllocationStateUnknown {
+    readonly type: 'Unknown';
+}
+export type TokenStandardV2AllocationState = TokenStandardV2AllocationStateCompleted | TokenStandardV2AllocationStatePending | TokenStandardV2AllocationStateUnknown;
+/**
+ * Reads exact active AllocationV2 contracts from one ACS snapshot.
+ *
+ * Contract IDs and decoded views are returned together so callers cannot validate an off-ledger allocation snapshot and
+ * later submit a different contract ID.
+ */
+export declare function getTokenStandardV2AllocationViewsByContractIds(params: GetTokenStandardV2AllocationViewsByContractIdsParams): Promise<TokenStandardV2AllocationContract[]>;
+/**
+ * Recovers the active Completed or Pending state for a Token Standard V2 allocation request.
+ *
+ * Unknown means only that no matching active contract is visible at the requested ACS snapshot. It must not be
+ * interpreted as Failed; recover Failed from the original transaction tree or command completion.
+ */
+export declare function discoverTokenStandardV2AllocationState(params: DiscoverTokenStandardV2AllocationStateParams): Promise<TokenStandardV2AllocationState>;
+//# sourceMappingURL=allocation-state.d.ts.map

package/build/src/utils/token-standard/v2/allocation-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"allocation-state.d.ts","sourceRoot":"","sources":["../../../../../src/utils/token-standard/v2/allocation-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2EAA2E,CAAC;AAC1H,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGtE,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,cAAc,CAAC;AAC5E,OAAO,KAAK,EAA0B,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAE/E,eAAO,MAAM,yCAAyC,6EACsB,CAAC;AAC7E,eAAO,MAAM,qDAAqD,+GAC4C,CAAC;AAE/G,eAAO,MAAM,uCAAuC;aAClD,aAAa,EAAE,kDAAkD;aACjE,sBAAsB,EAAE,2DAA2D;aACnF,cAAc,EAAE,mDAAmD;aACnE,SAAS,EAAE,8CAA8C;aACzD,SAAS,EAAE,8CAA8C;CACjD,CAAC;AAEX,MAAM,MAAM,uCAAuC,GACjD,CAAC,OAAO,uCAAuC,CAAC,CAAC,MAAM,OAAO,uCAAuC,CAAC,CAAC;AAEzG,+FAA+F;AAC/F,qBAAa,mCAAoC,SAAQ,WAAW;IAClE,SAAyB,IAAI,EAAE,MAAM,CAAC;IAEtC,YAAmB,IAAI,EAAE,uCAAuC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAGxG;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAC7F;AAED,gHAAgH;AAChH,MAAM,WAAW,qCAAqC;IACpD,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,4CAA4C;IAC3D,QAAQ,CAAC,MAAM,EAAE,oCAAoC,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,qCAAqC,CAAC;IACxD,mFAAmF;IACnF,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,oDAAoD;IACnE,QAAQ,CAAC,MAAM,EAAE,oCAAoC,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3C,sFAAsF;IACtF,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;CACxC;AAED,MAAM,WAAW,wCAAwC;IACvD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,UAAU,EAAE,uCAAuC,CAAC,YAAY,CAAC,CAAC;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;CACxC;AAED,MAAM,WAAW,uCAAuC;IACtD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,6BAA6B,CAAC;CAC9C;AAED,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,6BAA6B,CAAC;CAC9C;AAED,MAAM,WAAW,qCAAqC;IACpD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,wCAAwC,CAAC;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACpD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CAC1B;AAED,MAAM,MAAM,8BAA8B,GACtC,uCAAuC,GACvC,qCAAqC,GACrC,qCAAqC,CAAC;AAujB1C;;;;;GAKG;AACH,wBAAsB,8CAA8C,CAClE,MAAM,EAAE,oDAAoD,GAC3D,OAAO,CAAC,iCAAiC,EAAE,CAAC,CA6E9C;AAED;;;;;GAKG;AACH,wBAAsB,sCAAsC,CAC1D,MAAM,EAAE,4CAA4C,GACnD,OAAO,CAAC,8BAA8B,CAAC,CA8GzC"}