@skip-go/client 1.3.6 → 1.4.0

package/dist/esm/callbacks-B3kjKg0v.d.ts

@@ -0,0 +1,175 @@
+import { TxStatusResponse } from './api/postTransactionStatus.js';
+import { aS as TransferState, k as AxelarTransferState, p as CCTPTransferState, a8 as HyperlaneTransferState, aO as OPInitTransferState, w as GoFastTransferState, s as StargateTransferState, aP as LayerZeroTransferState, bf as RouteResponse, W as CosmosMsg, an as PostHandler, aT as TransferAssetRelease, aJ as TransactionState, aq as Route, aU as TransferStatus, T as Erc20Approval } from './swaggerTypes-DDwqIjap.js';
+import { A as ApiRequest } from './generateApi-C_xgtxrO.js';
+import { S as SignerGetters, b as GasOptions, U as UserAddress, T as TxResult } from './client-types-B7Fin0mq.js';
+import { TrackTxPollingProps } from './api/postTrackTransaction.js';
+
+type TransferEventStatus = "unconfirmed" | "signing" | "pending" | "completed" | "failed" | "approving" | "incomplete";
+type ClientTransferEvent = {
+    fromChainId: string;
+    toChainId: string;
+    state: TransferState | AxelarTransferState | CCTPTransferState | HyperlaneTransferState | OPInitTransferState | GoFastTransferState | StargateTransferState | LayerZeroTransferState;
+    status?: TransferEventStatus;
+    fromExplorerLink?: string;
+    toExplorerLink?: string;
+    explorerLink?: string;
+};
+
+/** Execute Route Options */
+type ExecuteRouteOptions = SignerGetters & GasOptions & TransactionCallbacks & Pick<ApiRequest<"msgs">, "timeoutSeconds"> & {
+    route: RouteResponse;
+    /**
+     * Addresses should be in the same order with the `chainIDs` in the `route`
+     */
+    userAddresses: UserAddress[];
+    simulate?: boolean;
+    slippageTolerancePercent?: string;
+    /**
+     * Arbitrary Tx to be executed before or after route msgs
+     */
+    beforeMsg?: CosmosMsg;
+    afterMsg?: CosmosMsg;
+    /**
+     * Set allowance amount to max if EVM transaction requires allowance approval.
+     */
+    useUnlimitedApproval?: boolean;
+    /**
+    /**
+     * If `skipApproval` is set to `true`, the router will bypass checking whether
+     * the signer has granted approval for the specified token contract on an EVM chain.
+     * This can be useful if approval has already been handled externally or there are race conditions.
+     */
+    bypassApprovalCheck?: boolean;
+    /**
+     * defaults to true
+     * If `batchSimulate` is set to `true`, it will simulate all messages in a batch before the first tx run.
+     * If `batchSimulate` is set to `false`, it will simulate each message one by one.
+     */
+    batchSimulate?: boolean;
+    /**
+     * Optional configuration for transaction polling behavior.
+     * - `maxRetries`: Maximum number of polling attempts (default: 5)
+     * - `retryInterval`: Retry interval in milliseconds (default: 1000)
+     * - `backoffMultiplier`: Exponential backoff multiplier for increasing delay between retries (default: 2.5)
+     * Example backoff with retryInterval = 1000 and backoffMultiplier = 2:
+     * 1st retry: 1000ms → 2nd: 2000ms → 3rd: 4000ms → 4th: 8000ms ...
+     */
+    trackTxPollingOptions?: TrackTxPollingProps;
+    /**
+     * If `batchSignTxs` is set to `true`, it will sign all transactions in a batch up front.
+     * If `batchSignTxs` is set to `false`, it will sign each transaction one by one.
+     */
+    batchSignTxs?: boolean;
+    /**
+     * Specify actions to perform after the route is completed
+     */
+    postRouteHandler?: PostHandler;
+    /**
+     * If `cosmosPriorityFeeDenom` is provided, it will be used to set the priority fee for Cosmos transactions.
+     * It should be a function that takes a chainId and returns the denom for the priority fee.
+     */
+    getCosmosPriorityFeeDenom?: (chainId: string) => Promise<string | undefined>;
+    /**
+     * SVM Fee Payer
+     *
+     * This is used to pay for the transaction fees on SVM chains.
+     * It should be an object with the following properties:
+     * `address`: The address of the fee payer.
+     * `signTransaction`: A function that takes the data to sign and returns a Promise that resolves to the signed transaction.
+     */
+    svmFeePayer?: {
+        address: string;
+        signTransaction: (dataToSign: Buffer) => Promise<Uint8Array>;
+    };
+};
+declare const executeRoute: (options: ExecuteRouteOptions) => Promise<void>;
+
+type RouteStatus = "unconfirmed" | "validating" | "allowance" | "signing" | "pending" | "completed" | "incomplete" | "failed";
+type TransactionStatus = "pending" | "success" | "failed";
+type TransactionDetails = {
+    chainId: string;
+    txHash?: string;
+    status?: TransactionStatus;
+    statusResponse?: TxStatusResponse;
+    explorerLink?: string;
+};
+type SimpleRoute = Partial<Pick<Route, "amountIn" | "amountOut" | "sourceAssetDenom" | "sourceAssetChainId" | "destAssetDenom" | "destAssetChainId" | "estimatedRouteDurationSeconds">>;
+type RouteDetails = {
+    id: string;
+    timestamp: number;
+    status: RouteStatus;
+    route: SimpleRoute;
+    txsRequired: number;
+    txsSigned: number;
+    transactionDetails: TransactionDetails[];
+    transferEvents: ClientTransferEvent[];
+    transferAssetRelease?: TransferAssetRelease;
+    senderAddress: string;
+    receiverAddress: string;
+};
+declare function getTransactionStatus(state?: TransactionState): TransactionStatus;
+type subscribeToRouteStatusProps = {
+    routeDetails?: RouteDetails;
+    onRouteStatusUpdated?: ExecuteRouteOptions["onRouteStatusUpdated"];
+    unsubscribe?: () => void;
+};
+type executeAndSubscribeToRouteStatusProps = {
+    routeDetails?: RouteDetails;
+    transactionDetails?: TransactionDetails[];
+    trackTxPollingOptions?: ExecuteRouteOptions["trackTxPollingOptions"];
+    onRouteStatusUpdated?: ExecuteRouteOptions["onRouteStatusUpdated"];
+    executeTransaction?: (index: number) => Promise<TxResult>;
+    onTransactionTracked?: ExecuteRouteOptions["onTransactionTracked"];
+    onTransactionCompleted?: ExecuteRouteOptions["onTransactionCompleted"];
+    options?: ExecuteRouteOptions;
+    routeId?: string;
+    isCancelled?: () => boolean;
+};
+declare const subscribeToRouteStatus: (props: subscribeToRouteStatusProps) => () => void;
+declare const executeAndSubscribeToRouteStatus: ({ transactionDetails, executeTransaction, trackTxPollingOptions, onTransactionTracked, onTransactionCompleted, routeDetails, onRouteStatusUpdated, options, routeId, isCancelled, }: executeAndSubscribeToRouteStatusProps) => Promise<void>;
+type updateRouteDetailsProps = {
+    routeDetails?: RouteDetails;
+    transactionDetails?: TransactionDetails[];
+    options?: Partial<ExecuteRouteOptions>;
+    status?: RouteStatus;
+    routeId?: string;
+};
+declare const updateRouteDetails: ({ transactionDetails, routeDetails, options, status, routeId, }: updateRouteDetailsProps) => RouteDetails;
+
+type CallbackStatus = "error" | "pending" | "completed";
+type TransactionCallbacks = {
+    onTransactionSignRequested?: (value: {
+        chainId: string;
+        txIndex: number;
+        signerAddress?: string;
+    }) => Promise<void>;
+    onTransactionSigned?: (txInfo: {
+        chainId: string;
+    }) => Promise<void>;
+    onTransactionBroadcast?: (txInfo: {
+        txHash: string;
+        chainId: string;
+    }) => Promise<void>;
+    onTransactionTracked?: (txInfo: {
+        txHash: string;
+        chainId: string;
+        explorerLink: string;
+    }) => Promise<void>;
+    onTransactionCompleted?: (txInfo: {
+        chainId: string;
+        txHash: string;
+        status?: TransferStatus;
+    }) => Promise<void>;
+    onRouteStatusUpdated?: (routeStatus: RouteDetails) => void;
+    onValidateGasBalance?: (value: {
+        chainId?: string;
+        txIndex?: number;
+        status: CallbackStatus;
+    }) => Promise<void>;
+    onApproveAllowance?: (value: {
+        allowance?: Erc20Approval;
+        status: CallbackStatus;
+    }) => Promise<void>;
+};
+
+export { type ExecuteRouteOptions as E, type RouteDetails as R, type TransactionDetails as T, type RouteStatus as a, type TransferEventStatus as b, type TransactionCallbacks as c, type TransactionStatus as d, executeRoute as e, type subscribeToRouteStatusProps as f, getTransactionStatus as g, type executeAndSubscribeToRouteStatusProps as h, executeAndSubscribeToRouteStatus as i, subscribeToRouteStatus as s, updateRouteDetails as u };