@zkp2p/cash 0.4.6 → 0.4.8

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { I as IntentStatus, C as CashPayoutInfo, a as IntentEntity, b as CashBuyerProfile, c as CashDepositInput, d as CreateDepositParamsArg, e as CashOrder, f as CashFill, g as CashCapabilities, h as CashoutResult, i as CashEstimate, j as CashFillStats, P as PrepareResult, k as CashPreparedStep, R as RelayExecutionResult, l as RelayQuote, m as RelayStatus, n as CashSourceCapabilities, T as TopUpResult, W as WithdrawResult } from './createCashClient-CL1SCbqF.cjs';
-export { o as CASH_ATTRIBUTION_CODE, p as CASH_REFERRAL_ATTRIBUTION_PREFIX, q as CashAsset, r as CashChain, s as CashClient, t as CashClientOptions, u as CashFillEta, v as CashLeg, w as CashMultiCurrencyLeg, x as CashNextAction, y as CashOrderState, z as CashPairFillStats, A as CashPayeeInput, B as CashPayout, D as CashPayoutPricing, E as CashPlatformCapability, F as CashPreparedStepKind, G as CashReceiveLeg, H as CashoutInput, J as CashoutOptions, K as CuratorPayeeDataInput, L as EstimateInput, M as EstimateOptions, N as MIN_CASHOUT_AMOUNT, O as OrdersOptions, Q as PreparedCashoutReceipt, S as RECOMMENDED_MIN_CASHOUT_AMOUNT, U as RelayOptions, V as RelayQuoteInput, X as RelaySourceInput, Y as RelayTransaction, Z as SignerOptions, _ as WatchOptions, $ as WithdrawOptions, a0 as buildCapabilities, a1 as createCashClient, a2 as normalizeCashPayee, a3 as toCashReferralAttributionCode } from './createCashClient-CL1SCbqF.cjs';
+import { I as IntentStatus, C as CashPayoutInfo, a as IntentEntity, b as CashBuyerProfile, c as CashDepositInput, d as CreateDepositParamsArg, e as CashOrder, f as CashFill, g as CashCapabilities, h as CashoutResult, i as CashEstimate, j as CashFillStats, P as PrepareResult, k as CashPreparedStep, R as RelayExecutionResult, l as RelayQuote, m as RelayStatus, n as CashSourceCapabilities, T as TopUpResult, W as WithdrawResult } from './createCashClient-BJmz3v4_.cjs';
+export { o as CASH_ATTRIBUTION_CODE, p as CASH_REFERRAL_ATTRIBUTION_PREFIX, q as CashAsset, r as CashChain, s as CashClient, t as CashClientOptions, u as CashFillEta, v as CashLeg, w as CashMultiCurrencyLeg, x as CashNextAction, y as CashOrderState, z as CashPairFillStats, A as CashPayeeInput, B as CashPayout, D as CashPayoutPricing, E as CashPlatformCapability, F as CashPreparedStepKind, G as CashReceiveLeg, H as CashoutInput, J as CashoutOptions, K as CuratorPayeeDataInput, L as EstimateInput, M as EstimateOptions, N as MIN_CASHOUT_AMOUNT, O as OrdersOptions, Q as PreparedCashoutReceipt, S as RECOMMENDED_MIN_CASHOUT_AMOUNT, U as RelayOptions, V as RelayQuoteInput, X as RelaySourceInput, Y as RelayTransaction, Z as SignerOptions, _ as WatchOptions, $ as WithdrawOptions, a0 as buildCapabilities, a1 as createCashClient, a2 as normalizeCashPayee, a3 as toCashReferralAttributionCode } from './createCashClient-BJmz3v4_.cjs';
 import { PaymentMethodCatalog, CurrencyType, OracleAdapterOverrides, OnchainCurrency, Zkp2pClient, PreparedTransaction } from '@zkp2p/sdk';
 export { CurrencyType, PreparedTransaction, RuntimeEnv } from '@zkp2p/sdk';
 import { Log, Abi } from 'viem';
@@ -61,6 +61,8 @@ type CashErrorRecovery = (CashSourceRecoveryBase & {
     depositId: string;
     groupIds: string[];
     transactionHash?: string;
+    /** Present when Relay funded the already-created deposit. */
+    source?: CashSourceRecoveryBase;
 };
 declare class CashError extends Error implements CashErrorShape {
     readonly code: CashErrorCode;
@@ -96,6 +98,7 @@ declare const errors: {
     indexerUnavailable: (operation: string, cause?: unknown) => CashError;
     payeeRegistrationFailed: (cause: unknown) => CashError;
     payeeVerificationRequired: (platform: string, cause?: unknown) => CashError;
+    /** @deprecated Cash-outs no longer require an atomic access-policy flow. */
     atomicAccessPolicyRequired: (platforms: readonly string[]) => CashError;
     sourceRouteUnsupportedInPrepare: () => CashError;
     sourceRecipientMismatch: (recipient: string, owner: string) => CashError;
@@ -136,7 +139,16 @@ declare const errors: {
     transactionRejected: (verb: string, cause?: unknown) => CashError;
     transactionSubmissionUnknown: (operation: string, cause?: unknown, recovery?: CashErrorRecovery) => CashError;
     transactionStatusUnknown: (txHash: string, cause?: unknown, operation?: string) => CashError;
-    accessPolicyConfigurationFailed: (depositId: string, groupIds: readonly string[], cause?: unknown, transactionHash?: string) => CashError;
+    accessPolicyConfigurationFailed: (depositId: string, groupIds: readonly string[], context?: {
+        cause?: unknown;
+        transactionHash?: string;
+        source?: {
+            amount: bigint;
+            requestId?: string;
+            txHashes: string[];
+            transactions?: CashSourceRecoveryBase["transactions"];
+        };
+    }) => CashError;
     escrowPaused: () => CashError;
     /** Generic fallback for an on-chain call that failed for an unrecognized reason. */
     chainCallFailed: (verb: string, cause?: unknown) => CashError;
@@ -598,6 +610,7 @@ declare const cashSourceCapabilitiesJsonSchema: z.ZodObject<{
     source: z.ZodLiteral<"relay-sdk">;
     asOf: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    source: "relay-sdk";
     chains: {
         id: number;
         name: string;
@@ -615,7 +628,6 @@ declare const cashSourceCapabilitiesJsonSchema: z.ZodObject<{
         blockProductionLagging: boolean;
         vmType?: string | undefined;
     }[];
-    source: "relay-sdk";
     destination: {
         symbol: string;
         chainId: number;
@@ -626,6 +638,7 @@ declare const cashSourceCapabilitiesJsonSchema: z.ZodObject<{
     };
     asOf: number;
 }, {
+    source: "relay-sdk";
     chains: {
         id: number;
         name: string;
@@ -643,7 +656,6 @@ declare const cashSourceCapabilitiesJsonSchema: z.ZodObject<{
         blockProductionLagging: boolean;
         vmType?: string | undefined;
     }[];
-    source: "relay-sdk";
     destination: {
         symbol: string;
         chainId: number;
@@ -2292,10 +2304,10 @@ declare const prepareResultJsonSchema: z.ZodObject<{
         to: string;
         value: string;
     }[];
-    accessPolicyRequired: boolean;
     register: {
         hashedOnchainIds: string[];
     };
+    accessPolicyRequired: boolean;
 }, {
     steps: {
         kind: "createDeposit" | "approve" | "pruneExpiredIntents" | "withdrawDeposit" | "removeFunds" | "addFunds";
@@ -2307,10 +2319,10 @@ declare const prepareResultJsonSchema: z.ZodObject<{
         to: string;
         value: string;
     }[];
-    accessPolicyRequired: boolean;
     register: {
         hashedOnchainIds: string[];
     };
+    accessPolicyRequired: boolean;
 }>;
 declare const withdrawResultJsonSchema: z.ZodObject<{
     depositId: z.ZodString;
@@ -2501,6 +2513,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             source: z.ZodLiteral<"relay-sdk">;
             asOf: z.ZodNumber;
         }, "strip", z.ZodTypeAny, {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2518,7 +2531,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -2529,6 +2541,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             };
             asOf: number;
         }, {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2546,7 +2559,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -2567,6 +2579,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             };
         };
         relay?: {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2584,7 +2597,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -2605,6 +2617,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             };
         };
         relay?: {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2622,7 +2635,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -2699,6 +2711,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             };
         };
         relay?: {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2716,7 +2729,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -2771,6 +2783,7 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
             };
         };
         relay?: {
+            source: "relay-sdk";
             chains: {
                 id: number;
                 name: string;
@@ -2788,7 +2801,6 @@ declare const cashCapabilitiesJsonSchema: z.ZodObject<{
                 blockProductionLagging: boolean;
                 vmType?: string | undefined;
             }[];
-            source: "relay-sdk";
             destination: {
                 symbol: string;
                 chainId: number;
@@ -3207,16 +3219,137 @@ declare const cashErrorRecoveryJsonSchema: z.ZodDiscriminatedUnion<"kind", [z.Zo
     depositId: z.ZodString;
     groupIds: z.ZodArray<z.ZodString, "many">;
     transactionHash: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodObject<{
+        readonly amount: z.ZodString;
+        readonly requestId: z.ZodOptional<z.ZodString>;
+        readonly txHashes: z.ZodArray<z.ZodString, "many">;
+        readonly transactions: z.ZodOptional<z.ZodObject<{
+            origin: z.ZodArray<z.ZodObject<{
+                hash: z.ZodString;
+                chainId: z.ZodNumber;
+                isBatchTx: z.ZodOptional<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }, {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }>, "many">;
+            destination: z.ZodArray<z.ZodObject<{
+                hash: z.ZodString;
+                chainId: z.ZodNumber;
+                isBatchTx: z.ZodOptional<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }, {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }>, "many">;
+        }, "strict", z.ZodTypeAny, {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        }, {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        }>>;
+    }, "strict", z.ZodTypeAny, {
+        amount: string;
+        txHashes: string[];
+        transactions?: {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        } | undefined;
+        requestId?: string | undefined;
+    }, {
+        amount: string;
+        txHashes: string[];
+        transactions?: {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        } | undefined;
+        requestId?: string | undefined;
+    }>>;
 }, "strict", z.ZodTypeAny, {
     depositId: string;
     kind: "configure-cashout-access-policy";
     groupIds: string[];
     transactionHash?: string | undefined;
+    source?: {
+        amount: string;
+        txHashes: string[];
+        transactions?: {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        } | undefined;
+        requestId?: string | undefined;
+    } | undefined;
 }, {
     depositId: string;
     kind: "configure-cashout-access-policy";
     groupIds: string[];
     transactionHash?: string | undefined;
+    source?: {
+        amount: string;
+        txHashes: string[];
+        transactions?: {
+            destination: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+            origin: {
+                chainId: number;
+                hash: string;
+                isBatchTx?: boolean | undefined;
+            }[];
+        } | undefined;
+        requestId?: string | undefined;
+    } | undefined;
 }>]>;
 declare const cashErrorJsonSchema: z.ZodObject<{
     code: z.ZodEnum<["ORACLE_UNSUPPORTED_CURRENCY", "ORACLE_READ_FAILED", "UNSUPPORTED_PLATFORM", "UNSUPPORTED_PLATFORM_CURRENCY", "AMOUNT_BELOW_MINIMUM", "INVALID_INTENT_AMOUNT_RANGE", "INVALID_PAYOUT_CURRENCIES", "INVALID_PAYOUT_PLATFORMS", "INVALID_REFERRAL_CODE", "ACTIVE_INTENT_BLOCKS_WITHDRAWAL", "NOTHING_TO_WITHDRAW", "INSUFFICIENT_AVAILABLE_FUNDS", "INSUFFICIENT_TOKEN_BALANCE", "ORDER_NOT_ACTIVE", "INVALID_DEPOSIT_ID", "ESCROW_PAUSED", "INDEXER_LAG", "INDEXER_UNAVAILABLE", "ORDER_NOT_FOUND", "PAYEE_REGISTRATION_FAILED", "PAYEE_VERIFICATION_REQUIRED", "ATOMIC_ACCESS_POLICY_REQUIRED", "SOURCE_ROUTE_UNSUPPORTED_IN_PREPARE", "SOURCE_RECIPIENT_MISMATCH", "SOURCE_CAPABILITIES_FAILED", "SOURCE_QUOTE_FAILED", "SOURCE_NONCE_MANAGER_REQUIRED", "SOURCE_EXECUTION_FAILED", "SOURCE_STATUS_FAILED", "SOURCE_ROUTE_COMPLETED_CASHOUT_FAILED", "SOURCE_CASHOUT_SUBMISSION_UNKNOWN", "SOURCE_CASHOUT_STATUS_UNKNOWN", "DEPOSIT_RESOLUTION_FAILED", "ACCESS_POLICY_CONFIGURATION_FAILED", "ALLOWANCE_NOT_VISIBLE", "SIGNER_REQUIRED", "SIGNER_CHAIN_MISMATCH", "SIGNER_CHAIN_UNAVAILABLE", "WATCH_TIMEOUT", "TRANSACTION_REJECTED", "TRANSACTION_FAILED", "TRANSACTION_SUBMISSION_UNKNOWN", "TRANSACTION_STATUS_UNKNOWN"]>;
@@ -3608,16 +3741,137 @@ declare const cashErrorJsonSchema: z.ZodObject<{
         depositId: z.ZodString;
         groupIds: z.ZodArray<z.ZodString, "many">;
         transactionHash: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodObject<{
+            readonly amount: z.ZodString;
+            readonly requestId: z.ZodOptional<z.ZodString>;
+            readonly txHashes: z.ZodArray<z.ZodString, "many">;
+            readonly transactions: z.ZodOptional<z.ZodObject<{
+                origin: z.ZodArray<z.ZodObject<{
+                    hash: z.ZodString;
+                    chainId: z.ZodNumber;
+                    isBatchTx: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }, {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }>, "many">;
+                destination: z.ZodArray<z.ZodObject<{
+                    hash: z.ZodString;
+                    chainId: z.ZodNumber;
+                    isBatchTx: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }, {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }>, "many">;
+            }, "strict", z.ZodTypeAny, {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            }, {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            }>>;
+        }, "strict", z.ZodTypeAny, {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        }, {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        }>>;
     }, "strict", z.ZodTypeAny, {
         depositId: string;
         kind: "configure-cashout-access-policy";
         groupIds: string[];
         transactionHash?: string | undefined;
+        source?: {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        } | undefined;
     }, {
         depositId: string;
         kind: "configure-cashout-access-policy";
         groupIds: string[];
         transactionHash?: string | undefined;
+        source?: {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        } | undefined;
     }>]>>;
 }, "strict", z.ZodTypeAny, {
     message: string;
@@ -3705,6 +3959,23 @@ declare const cashErrorJsonSchema: z.ZodObject<{
         kind: "configure-cashout-access-policy";
         groupIds: string[];
         transactionHash?: string | undefined;
+        source?: {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        } | undefined;
     } | undefined;
 }, {
     message: string;
@@ -3792,6 +4063,23 @@ declare const cashErrorJsonSchema: z.ZodObject<{
         kind: "configure-cashout-access-policy";
         groupIds: string[];
         transactionHash?: string | undefined;
+        source?: {
+            amount: string;
+            txHashes: string[];
+            transactions?: {
+                destination: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+                origin: {
+                    chainId: number;
+                    hash: string;
+                    isBatchTx?: boolean | undefined;
+                }[];
+            } | undefined;
+            requestId?: string | undefined;
+        } | undefined;
     } | undefined;
 }>;
 type CashOrderJson = z.infer<typeof cashOrderJsonSchema>;