@skip-go/client 1.2.1 → 1.2.2

package/dist/chunk-35T3HXEL.js

@@ -0,0 +1,180 @@
+import { getCosmosGasAmountForMessage } from './chunk-TV2XPAIF.js';
+import { BigNumber } from './chunk-VQ5SIQWU.js';
+import { getSigningStargateClient } from './chunk-72PK3PKI.js';
+import { ClientState, balances } from './chunk-4XUWIG3Z.js';
+import { GasPrice, calculateFee } from '@cosmjs/stargate';
+import { Decimal } from '@cosmjs/math';
+
+var validateCosmosGasBalance = async ({
+  chainId,
+  signerAddress,
+  messages,
+  getFallbackGasAmount,
+  getOfflineSigner,
+  txIndex,
+  simulate,
+  getCosmosPriorityFeeDenom
+}) => {
+  const skipAssets = (await ClientState.getSkipAssets({ chainId }))?.[chainId];
+  const skipChains = await ClientState.getSkipChains();
+  const prioFeeDenom = await getCosmosPriorityFeeDenom?.(chainId);
+  const chain = skipChains?.find((c) => c.chainId === chainId);
+  if (!chain) {
+    throw new Error(`failed to find chain id '${chainId}'`);
+  }
+  const { feeAssets } = chain;
+  if (!feeAssets) {
+    throw new Error(`failed to find fee assets for chain id '${chainId}'`);
+  }
+  const estimatedGasAmount = await (async () => {
+    try {
+      if (!simulate) throw new Error("simulate");
+      if (txIndex !== 0 && chainId === "noble-1") {
+        return "0";
+      }
+      const { stargateClient } = await getSigningStargateClient({
+        chainId,
+        getOfflineSigner
+      });
+      const estimatedGas = await getCosmosGasAmountForMessage(
+        stargateClient,
+        signerAddress,
+        chainId,
+        messages
+      );
+      return estimatedGas;
+    } catch (e) {
+      const error = e;
+      if (error.message === "simulate" && !getFallbackGasAmount) {
+        throw new Error(`unable to get gas amount for ${chainId}'s message(s)`);
+      }
+      if (getFallbackGasAmount) {
+        const fallbackGasAmount = await getFallbackGasAmount(
+          chainId,
+          "cosmos" /* Cosmos */
+        );
+        if (!fallbackGasAmount) {
+          throw new Error(`unable to estimate gas for message(s) ${messages}`);
+        }
+        return String(fallbackGasAmount);
+      }
+      throw error;
+    }
+  })();
+  const fees = feeAssets.map((asset) => {
+    const gasPrice = (() => {
+      if (!asset?.gasPrice) return void 0;
+      let price = asset.gasPrice.average;
+      if (price === "") {
+        price = asset.gasPrice.high;
+      }
+      if (price === "") {
+        price = asset.gasPrice.low;
+      }
+      if (!price) return;
+      return new GasPrice(
+        Decimal.fromUserInput(BigNumber(price).toFixed(), 18),
+        asset?.denom ?? ""
+      );
+    })();
+    if (!gasPrice) {
+      return null;
+    }
+    if (chainId === "noble-1") {
+      if (asset.denom.toLowerCase() === "ibc/EF48E6B1A1A19F47ECAEA62F5670C37C0580E86A9E88498B7E393EB6F49F33C0".toLowerCase()) {
+        const fee2 = calculateFee(2e6, gasPrice);
+        return fee2;
+      }
+      const fee = calculateFee(2e5, gasPrice);
+      return fee;
+    }
+    return calculateFee(Math.ceil(parseFloat(estimatedGasAmount)), gasPrice);
+  });
+  const feeBalance = await balances({
+    chains: {
+      [chainId]: {
+        address: signerAddress,
+        denoms: feeAssets.map((asset) => asset.denom ?? "")
+      }
+    }
+  });
+  const validatedAssets = feeAssets.map((asset, index) => {
+    const chainAsset = skipAssets?.find((x) => x.denom === asset.denom);
+    const symbol = chainAsset?.recommendedSymbol?.toUpperCase();
+    const decimal = Number(chainAsset?.decimals);
+    if (!chainAsset) {
+      return {
+        error: `(${chain?.prettyName}) Unable to find asset for ${asset.denom}`
+      };
+    }
+    if (isNaN(decimal))
+      return {
+        error: `(${chain?.prettyName}) Unable to find decimal for ${symbol}`
+      };
+    const fee = fees[index];
+    if (!fee) {
+      return {
+        error: `(${chain?.prettyName}) Unable to calculate fee for ${symbol}`,
+        asset
+      };
+    }
+    if (txIndex !== 0 && chainId === "noble-1") {
+      return {
+        error: null,
+        asset,
+        fee
+      };
+    }
+    let balance = feeBalance?.chains?.[chainId]?.denoms?.[asset?.denom ?? ""];
+    if (!balance) {
+      balance = {
+        amount: "0",
+        formattedAmount: "0"
+      };
+    }
+    if (!fee.amount[0]?.amount) {
+      return {
+        error: `(${chain?.prettyName}) Unable to get fee for ${symbol}`,
+        asset
+      };
+    }
+    if (parseInt(balance?.amount ?? "") < parseInt(fee.amount[0]?.amount)) {
+      const userAmount = new BigNumber(parseFloat(balance?.amount ?? "")).shiftedBy(-decimal).toFixed(decimal);
+      const feeAmount = new BigNumber(parseFloat(fee.amount[0]?.amount)).shiftedBy(-decimal).toFixed(decimal);
+      return {
+        error: `Insufficient balance for gas on ${chain?.prettyName}. Need ${feeAmount} ${symbol} but only have ${userAmount} ${symbol}.`,
+        asset
+      };
+    }
+    return {
+      error: null,
+      asset,
+      fee
+    };
+  });
+  if (prioFeeDenom) {
+    const availableAssets = validatedAssets.filter(
+      (res) => res?.error === null
+    );
+    const prioFeeAsset = availableAssets.find(
+      (res) => res?.asset?.denom === prioFeeDenom
+    );
+    if (prioFeeAsset) {
+      return prioFeeAsset;
+    }
+  }
+  const feeUsed = validatedAssets.find((res) => res?.error === null);
+  if (!feeUsed) {
+    if (validatedAssets.length > 1) {
+      throw new Error(
+        validatedAssets[0]?.error || `Insufficient fee token to initiate transfer on ${chain.prettyName}.`
+      );
+    }
+    throw new Error(
+      validatedAssets[0]?.error || `Insufficient fee token to initiate transfer on ${chain.prettyName}.`
+    );
+  }
+  return feeUsed;
+};
+
+export { validateCosmosGasBalance };

package/dist/{chunk-TTLOL6VT.js → chunk-PFJUQWAV.js}

@@ -1,5 +1,6 @@
+import { validateCosmosGasBalance } from './chunk-35T3HXEL.js';
 import { waitForTransaction } from './chunk-COJAW7OW.js';
-import { getEncodeObjectFromCosmosMessage, getCosmosGasAmountForMessage, getEncodeObjectFromCosmosMessageInjective } from './chunk-TV2XPAIF.js';
+import { getEncodeObjectFromCosmosMessage, getEncodeObjectFromCosmosMessageInjective } from './chunk-TV2XPAIF.js';
 import { getEVMGasAmountForMessage } from './chunk-GV2QOWB4.js';
 import { BigNumber } from './chunk-VQ5SIQWU.js';
 import { GAS_STATION_CHAIN_IDS } from './chunk-SWYON2RG.js';
@@ -13,7 +14,7 @@ import { ClientState, balances } from './chunk-4XUWIG3Z.js';
 import { ApiState, wait, createRequestClient, toCamel } from './chunk-YABXOO3H.js';
 import { PublicKey, Transaction, Connection, LAMPORTS_PER_SOL } from '@solana/web3.js';
 import { bech32m, bech32 } from 'bech32';
-import { StargateClient, GasPrice, calculateFee } from '@cosmjs/stargate';
+import { StargateClient } from '@cosmjs/stargate';
 import { TxRaw } from 'cosmjs-types/cosmos/tx/v1beta1/tx.js';
 import { isOfflineDirectSigner, makeAuthInfoBytes, makeSignDoc, encodePubkey } from '@cosmjs/proto-signing';
 import { fromBase64, toBase64 } from '@cosmjs/encoding';
@@ -22,7 +23,7 @@ import { BigNumberInBase, DEFAULT_BLOCK_TIMEOUT_HEIGHT, DEFAULT_STD_FEE } from '
 import { pubkeyType as pubkeyType$1, makeSignDoc as makeSignDoc$1, encodeSecp256k1Pubkey } from '@cosmjs/amino';
 import { PubKey } from 'cosmjs-types/cosmos/crypto/secp256k1/keys.js';
 import { Any } from 'cosmjs-types/google/protobuf/any.js';
-import { Int53, Decimal } from '@cosmjs/math';
+import { Int53 } from '@cosmjs/math';
 import { SignMode } from 'cosmjs-types/cosmos/tx/signing/v1beta1/signing.js';
 import { isAddress, publicActions, maxUint256, formatUnits } from 'viem';
 
@@ -819,157 +820,6 @@ var executeSvmTransaction = async (tx, options) => {
     }
   }
 };
-var validateCosmosGasBalance = async ({
-  chainId,
-  signerAddress,
-  messages: messages2,
-  getFallbackGasAmount,
-  getOfflineSigner,
-  txIndex,
-  simulate
-}) => {
-  const skipAssets = (await ClientState.getSkipAssets({ chainId }))?.[chainId];
-  const skipChains = await ClientState.getSkipChains();
-  const chain = skipChains?.find((c) => c.chainId === chainId);
-  if (!chain) {
-    throw new Error(`failed to find chain id '${chainId}'`);
-  }
-  const { feeAssets } = chain;
-  if (!feeAssets) {
-    throw new Error(`failed to find fee assets for chain id '${chainId}'`);
-  }
-  const estimatedGasAmount = await (async () => {
-    try {
-      if (!simulate) throw new Error("simulate");
-      if (txIndex !== 0 && chainId === "noble-1") {
-        return "0";
-      }
-      const { stargateClient } = await getSigningStargateClient({
-        chainId,
-        getOfflineSigner
-      });
-      const estimatedGas = await getCosmosGasAmountForMessage(
-        stargateClient,
-        signerAddress,
-        chainId,
-        messages2
-      );
-      return estimatedGas;
-    } catch (e) {
-      const error = e;
-      if (error.message === "simulate" && !getFallbackGasAmount) {
-        throw new Error(`unable to get gas amount for ${chainId}'s message(s)`);
-      }
-      if (getFallbackGasAmount) {
-        const fallbackGasAmount = await getFallbackGasAmount(chainId, "cosmos" /* Cosmos */);
-        if (!fallbackGasAmount) {
-          throw new Error(`unable to estimate gas for message(s) ${messages2}`);
-        }
-        return String(fallbackGasAmount);
-      }
-      throw error;
-    }
-  })();
-  const fees = feeAssets.map((asset) => {
-    const gasPrice = (() => {
-      if (!asset?.gasPrice) return void 0;
-      let price = asset.gasPrice.average;
-      if (price === "") {
-        price = asset.gasPrice.high;
-      }
-      if (price === "") {
-        price = asset.gasPrice.low;
-      }
-      if (!price) return;
-      return new GasPrice(
-        Decimal.fromUserInput(BigNumber(price).toFixed(), 18),
-        asset?.denom ?? ""
-      );
-    })();
-    if (!gasPrice) {
-      return null;
-    }
-    if (chainId === "noble-1") {
-      const fee = calculateFee(2e5, gasPrice);
-      return fee;
-    }
-    return calculateFee(Math.ceil(parseFloat(estimatedGasAmount)), gasPrice);
-  });
-  const feeBalance = await balances({
-    chains: {
-      [chainId]: {
-        address: signerAddress,
-        denoms: feeAssets.map((asset) => asset.denom ?? "")
-      }
-    }
-  });
-  const validatedAssets = feeAssets.map((asset, index) => {
-    const chainAsset = skipAssets?.find((x) => x.denom === asset.denom);
-    const symbol = chainAsset?.recommendedSymbol?.toUpperCase();
-    const decimal = Number(chainAsset?.decimals);
-    if (!chainAsset) {
-      return {
-        error: `(${chain?.prettyName}) Unable to find asset for ${asset.denom}`
-      };
-    }
-    if (isNaN(decimal))
-      return {
-        error: `(${chain?.prettyName}) Unable to find decimal for ${symbol}`
-      };
-    const fee = fees[index];
-    if (!fee) {
-      return {
-        error: `(${chain?.prettyName}) Unable to calculate fee for ${symbol}`,
-        asset
-      };
-    }
-    if (txIndex !== 0 && chainId === "noble-1") {
-      return {
-        error: null,
-        asset,
-        fee
-      };
-    }
-    let balance = feeBalance?.chains?.[chainId]?.denoms?.[asset?.denom ?? ""];
-    if (!balance) {
-      balance = {
-        amount: "0",
-        formattedAmount: "0"
-      };
-    }
-    if (!fee.amount[0]?.amount) {
-      return {
-        error: `(${chain?.prettyName}) Unable to get fee for ${symbol}`,
-        asset
-      };
-    }
-    if (parseInt(balance?.amount ?? "") < parseInt(fee.amount[0]?.amount)) {
-      const userAmount = new BigNumber(parseFloat(balance?.amount ?? "")).shiftedBy(-decimal).toFixed(decimal);
-      const feeAmount = new BigNumber(parseFloat(fee.amount[0]?.amount)).shiftedBy(-decimal).toFixed(decimal);
-      return {
-        error: `Insufficient balance for gas on ${chain?.prettyName}. Need ${feeAmount} ${symbol} but only have ${userAmount} ${symbol}.`,
-        asset
-      };
-    }
-    return {
-      error: null,
-      asset,
-      fee
-    };
-  });
-  const feeUsed = validatedAssets.find((res) => res?.error === null);
-  if (!feeUsed) {
-    if (validatedAssets.length > 1) {
-      throw new Error(
-        validatedAssets[0]?.error || `Insufficient fee token to initiate transfer on ${chain.prettyName}.`
-      );
-    }
-    throw new Error(
-      validatedAssets[0]?.error || `Insufficient fee token to initiate transfer on ${chain.prettyName}.`
-    );
-  }
-  return feeUsed;
-};
 var validateEvmTokenApproval = async ({
   requiredErc20Approvals,
   signer,
@@ -1209,7 +1059,8 @@ var validateGasBalances = async ({
   simulate,
   disabledChainIds,
   enabledChainIds,
-  useUnlimitedApproval
+  useUnlimitedApproval,
+  getCosmosPriorityFeeDenom
 }) => {
   const validateResult = await Promise.all(
     txs.map(async (tx, i) => {
@@ -1231,7 +1082,8 @@ var validateGasBalances = async ({
             getFallbackGasAmount,
             getOfflineSigner: getCosmosSigner,
             txIndex: i,
-            simulate
+            simulate,
+            getCosmosPriorityFeeDenom
           });
           return res;
         } catch (e) {
@@ -1359,7 +1211,8 @@ var executeTransactions = async (options) => {
     getEvmSigner,
     onValidateGasBalance,
     simulate,
-    disabledChainIds: validateChainIds
+    disabledChainIds: validateChainIds,
+    getCosmosPriorityFeeDenom: options.getCosmosPriorityFeeDenom
   });
   const validateEnabledChainIds = async (chainId) => {
     await validateGasBalances({
@@ -1369,7 +1222,8 @@ var executeTransactions = async (options) => {
       getEvmSigner,
       onValidateGasBalance,
       simulate,
-      enabledChainIds: !batchSimulate ? [chainId] : validateChainIds
+      enabledChainIds: !batchSimulate ? [chainId] : validateChainIds,
+      getCosmosPriorityFeeDenom: options.getCosmosPriorityFeeDenom
     });
   };
   let signedTxs = [];

package/dist/index.d.ts

@@ -25,6 +25,7 @@ export { SetApiOptionsProps, setApiOptions } from './public-functions/setApiOpti
 export { waitForTransaction } from './public-functions/waitForTransaction.js';
 export { getCosmosGasAmountForMessage } from './public-functions/getCosmosGasAmountForMessage.js';
 export { getEVMGasAmountForMessage } from './public-functions/getEvmGasAmountForMessage.js';
+export { validateCosmosGasBalance } from './public-functions/validateCosmosGasBalance.js';
 export { SubmitRequest, SubmitResponse, submit } from './api/postSubmit.js';
 import '@cosmjs/amino';
 import '@cosmjs/proto-signing';

package/dist/index.js

@@ -1,5 +1,6 @@
 export { setClientOptions } from './chunk-A4M35XLF.js';
-export { executeRoute } from './chunk-TTLOL6VT.js';
+export { executeRoute } from './chunk-PFJUQWAV.js';
+export { validateCosmosGasBalance } from './chunk-35T3HXEL.js';
 export { waitForTransaction } from './chunk-COJAW7OW.js';
 export { transactionStatus } from './chunk-XZV42PVV.js';
 export { getCosmosGasAmountForMessage } from './chunk-TV2XPAIF.js';

package/dist/public-functions/executeRoute.d.ts

@@ -58,6 +58,11 @@ type ExecuteRouteOptions = SignerGetters & GasOptions & TransactionCallbacks & P
      * 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>;
 };
 declare const executeRoute: (options: ExecuteRouteOptions) => Promise<void>;
 

package/dist/public-functions/executeRoute.js

@@ -1,4 +1,5 @@
-export { executeRoute } from '../chunk-TTLOL6VT.js';
+export { executeRoute } from '../chunk-PFJUQWAV.js';
+import '../chunk-35T3HXEL.js';
 import '../chunk-COJAW7OW.js';
 import '../chunk-XZV42PVV.js';
 import '../chunk-TV2XPAIF.js';

package/dist/public-functions/validateCosmosGasBalance.d.ts

@@ -0,0 +1,42 @@
+import * as _cosmjs_stargate from '@cosmjs/stargate';
+import { W as CosmosMsg, a3 as FeeAsset } from '../swaggerTypes-BpJPRbC3.js';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+import { ExecuteRouteOptions } from './executeRoute.js';
+import { G as GetFallbackGasAmount } from '../client-types-DRmsTfeT.js';
+import '../callbacks-CPh0dr86.js';
+import '../generateApi-D7KXciAd.js';
+import '../api/postTrackTransaction.js';
+import '@cosmjs/amino';
+import 'viem';
+import '@solana/wallet-adapter-base';
+
+type ValidateCosmosGasBalanceProps = {
+    chainId: string;
+    signerAddress: string;
+    messages?: CosmosMsg[];
+    getOfflineSigner?: (chainId: string) => Promise<OfflineSigner>;
+    getFallbackGasAmount?: GetFallbackGasAmount;
+    txIndex?: number;
+    simulate?: ExecuteRouteOptions["simulate"];
+    getCosmosPriorityFeeDenom?: ExecuteRouteOptions["getCosmosPriorityFeeDenom"];
+};
+/**
+ *
+ * Validate gas balance for cosmos messages returns a fee asset and StdFee to be used
+ *
+ */
+declare const validateCosmosGasBalance: ({ chainId, signerAddress, messages, getFallbackGasAmount, getOfflineSigner, txIndex, simulate, getCosmosPriorityFeeDenom, }: ValidateCosmosGasBalanceProps) => Promise<{
+    error: string;
+    asset?: undefined;
+    fee?: undefined;
+} | {
+    error: string;
+    asset: FeeAsset;
+    fee?: undefined;
+} | {
+    error: null;
+    asset: FeeAsset;
+    fee: _cosmjs_stargate.StdFee;
+}>;
+
+export { type ValidateCosmosGasBalanceProps, validateCosmosGasBalance };

package/dist/public-functions/validateCosmosGasBalance.js

@@ -0,0 +1,9 @@
+export { validateCosmosGasBalance } from '../chunk-35T3HXEL.js';
+import '../chunk-TV2XPAIF.js';
+import '../chunk-TD63P2AG.js';
+import '../chunk-VQ5SIQWU.js';
+import '../chunk-72PK3PKI.js';
+import '../chunk-36MCR5DZ.js';
+import '../chunk-4XUWIG3Z.js';
+import '../chunk-YABXOO3H.js';
+import '../chunk-UXUJNZOA.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@skip-go/client",
   "description": "JavaScript SDK for Skip Go API",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "repository": "https://github.com/skip-mev/skip-go",
   "type": "module",
   "main": "./dist/index.js",