@swapkit/helpers 1.0.0-rc.101 → 1.0.0-rc.103

package/dist/index.js

@@ -1263,6 +1263,7 @@ var LedgerErrorCode;
   LedgerErrorCode2[LedgerErrorCode2["TC_NotFound"] = 65535] = "TC_NotFound";
 })(LedgerErrorCode || (LedgerErrorCode = {}));
 // src/types/sdk.ts
+import {z} from "zod";
 var FeeOption;
 (function(FeeOption2) {
   FeeOption2["Average"] = "average";
@@ -1285,6 +1286,347 @@ var MemoType;
   MemoType2["OPEN_LOAN"] = "$+";
   MemoType2["CLOSE_LOAN"] = "$-";
 })(MemoType || (MemoType = {}));
+var QuoteRequestSchema = z.object({
+  sellAsset: z.string({
+    description: "Asset to sell"
+  }),
+  buyAsset: z.string({
+    description: "Asset to buy"
+  }),
+  sellAmount: z.number({
+    description: "Amount of asset to sell"
+  }).refine((amount) => amount > 0, {
+    message: "sellAmount must be greater than 0",
+    path: ["sellAmount"]
+  }),
+  providers: z.optional(z.array(z.string({
+    description: "List of providers to use"
+  }))),
+  sourceAddress: z.optional(z.string({
+    description: "Address to send asset from"
+  })),
+  destinationAddress: z.optional(z.string({
+    description: "Address to send asset to"
+  })),
+  slippage: z.optional(z.number({
+    description: "Slippage tolerance as a percentage. Default is 3%."
+  })),
+  affiliate: z.optional(z.string({
+    description: "Affiliate thorname"
+  })),
+  affiliateFee: z.optional(z.number({
+    description: "Affiliate fee in basis points"
+  }).refine((fee) => {
+    return fee === Math.floor(fee) && fee >= 0;
+  }, { message: "affiliateFee must be a positive integer", path: ["affiliateFee"] })),
+  allowSmartContractSender: z.optional(z.boolean({
+    description: "Allow smart contract as sender"
+  })),
+  allowSmartContractReceiver: z.optional(z.boolean({
+    description: "Allow smart contract as recipient"
+  })),
+  disableSecurityChecks: z.optional(z.boolean({
+    description: "Disable security checks"
+  }))
+}).refine((data) => data.sellAsset !== data.buyAsset, {
+  message: "Must be different",
+  path: ["sellAsset", "buyAsset"]
+});
+// src/types/quotes.ts
+import {z as z2} from "zod";
+var WarningCodeEnum;
+(function(WarningCodeEnum2) {
+  WarningCodeEnum2["highSlippage"] = "highSlippage";
+  WarningCodeEnum2["highPriceImpact"] = "highPriceImpact";
+})(WarningCodeEnum || (WarningCodeEnum = {}));
+var EVMTransactionDetailsParamsSchema = z2.array(z2.union([
+  z2.string(),
+  z2.number(),
+  z2.array(z2.string()),
+  z2.object({
+    from: z2.string(),
+    value: z2.string()
+  }).describe("Parameters to pass to the contract method")
+]));
+var EVMTransactionDetailsSchema = z2.object({
+  contractAddress: z2.string({
+    description: "Address of the contract to interact with"
+  }),
+  contractMethod: z2.string({
+    description: "Name of the method to call"
+  }),
+  contractParams: EVMTransactionDetailsParamsSchema,
+  contractParamNames: z2.array(z2.string({
+    description: "Names of the parameters to pass to the contract method"
+  })),
+  approvalToken: z2.optional(z2.string({
+    description: "Address of the token to approve spending of"
+  })),
+  approvalSpender: z2.optional(z2.string({
+    description: "Address of the spender to approve"
+  }))
+});
+var EstimatedTimeSchema = z2.object({
+  inbound: z2.optional(z2.number({
+    description: "Time to receive inbound asset in seconds"
+  })),
+  swap: z2.optional(z2.number({
+    description: "Time to swap assets in seconds"
+  })),
+  outbound: z2.optional(z2.number({
+    description: "Time to receive outbound asset in seconds"
+  })),
+  total: z2.number({
+    description: "Total time in seconds"
+  })
+});
+var ProviderName;
+(function(ProviderName2) {
+  ProviderName2["CHAINFLIP"] = "CHAINFLIP";
+  ProviderName2["TRADERJOE_V1"] = "TRADERJOE_V1";
+  ProviderName2["PANGOLIN_V1"] = "PANGOLIN_V1";
+  ProviderName2["UNISWAP_V2"] = "UNISWAP_V2";
+  ProviderName2["THORCHAIN"] = "THORCHAIN";
+  ProviderName2["THORCHAIN_STREAMING"] = "THORCHAIN_STREAMING";
+  ProviderName2["MAYACHAIN"] = "MAYACHAIN";
+  ProviderName2["ONEINCH"] = "ONEINCH";
+  ProviderName2["SUSHISWAP_V2"] = "SUSHISWAP_V2";
+  ProviderName2["WOOFI_V2"] = "WOOFI_V2";
+  ProviderName2["PANCAKESWAP"] = "PANCAKESWAP";
+})(ProviderName || (ProviderName = {}));
+var FeeTypeEnum;
+(function(FeeTypeEnum2) {
+  FeeTypeEnum2["LIQUIDITY"] = "liquidity";
+  FeeTypeEnum2["NETWORK"] = "network";
+  FeeTypeEnum2["INBOUND"] = "inbound";
+  FeeTypeEnum2["OUTBOUND"] = "outbound";
+  FeeTypeEnum2["AFFILIATE"] = "affiliate";
+  FeeTypeEnum2["TAX"] = "tax";
+})(FeeTypeEnum || (FeeTypeEnum = {}));
+var FeesSchema = z2.array(z2.object({
+  type: z2.nativeEnum(FeeTypeEnum),
+  amount: z2.string(),
+  asset: z2.string(),
+  chain: z2.string(),
+  protocol: z2.nativeEnum(ProviderName)
+}));
+var RouteLegSchema = z2.object({
+  sellAsset: z2.string({
+    description: "Asset to sell"
+  }),
+  buyAsset: z2.string({
+    description: "Asset to buy"
+  }),
+  provider: z2.nativeEnum(ProviderName),
+  sourceAddress: z2.string({
+    description: "Source address"
+  }),
+  destinationAddress: z2.string({
+    description: "Destination address"
+  }),
+  estimatedTime: EstimatedTimeSchema.optional(),
+  affiliate: z2.string({
+    description: "Affiliate address"
+  }).optional(),
+  affiliateFee: z2.number({
+    description: "Affiliate fee"
+  }).optional(),
+  slipPercentage: z2.number({
+    description: "Slippage as a percentage"
+  })
+});
+var RouteLegWithoutAddressesSchema = RouteLegSchema.omit({
+  sourceAddress: true,
+  destinationAddress: true,
+  slipPercentage: true
+});
+var RouteQuoteMetadataAssetSchema = z2.object({
+  name: z2.string({
+    description: "Asset name"
+  }),
+  price: z2.number({
+    description: "Price in USD"
+  }),
+  image: z2.string({
+    description: "Asset image"
+  })
+});
+var RouteQuoteMetadataSchema = z2.object({
+  priceImpact: z2.number({
+    description: "Price impact"
+  }),
+  assets: z2.optional(z2.array(RouteQuoteMetadataAssetSchema))
+});
+var RouteQuoteWarningSchema = z2.array(z2.object({
+  code: z2.nativeEnum(WarningCodeEnum),
+  display: z2.string(),
+  tooltip: z2.string().optional()
+}));
+var RouteQuoteLegSchema = z2.object({
+  sellAsset: z2.string({
+    description: "Asset to sell"
+  }),
+  buyAsset: z2.string({
+    description: "Asset to buy"
+  }),
+  provider: z2.nativeEnum(ProviderName),
+  buyAmount: z2.string({
+    description: "Amount of asset to buy"
+  }),
+  buyAmountMaxSlippage: z2.string({
+    description: "Amount of asset to buy"
+  }),
+  sellAmount: z2.string({
+    description: "Amount of asset to sell"
+  }),
+  sourceAddress: z2.string({
+    description: "Source address"
+  }),
+  destinationAddress: z2.string({
+    description: "Destination address"
+  }),
+  slippageBps: z2.number({
+    description: "Slippage in bps"
+  }),
+  targetAddress: z2.optional(z2.string({
+    description: "Target address for contract call or transfer address"
+  })),
+  inboundAddress: z2.optional(z2.string({
+    description: "Inbound address"
+  })),
+  routerAddress: z2.optional(z2.string({
+    description: "Inbound address"
+  })),
+  contractMethod: z2.optional(z2.string({
+    description: "Contract method"
+  })),
+  fees: z2.optional(FeesSchema),
+  estimatedTime: z2.optional(EstimatedTimeSchema),
+  memo: z2.optional(z2.string({
+    description: "Memo"
+  })),
+  expiration: z2.optional(z2.string({
+    description: "Expiration"
+  }))
+});
+var RouteQuoteSchema = z2.object({
+  providers: z2.array(z2.nativeEnum(ProviderName)),
+  sellAsset: z2.string({
+    description: "Asset to sell"
+  }),
+  sellAmount: z2.string({
+    description: "sell amount"
+  }),
+  buyAsset: z2.string({
+    description: "Asset to buy"
+  }),
+  expectedBuyAmount: z2.string({
+    description: "Expected Buy amount"
+  }),
+  expectedBuyAmountMaxSlippage: z2.string({
+    description: "Expected Buy amount max slippage"
+  }),
+  sourceAddress: z2.string({
+    description: "Source address"
+  }),
+  destinationAddress: z2.string({
+    description: "Destination address"
+  }),
+  targetAddress: z2.optional(z2.string({
+    description: "Target address"
+  })),
+  routerAddress: z2.optional(z2.string({
+    description: "Router address"
+  })),
+  inboundAddress: z2.optional(z2.string({
+    description: "Inbound address"
+  })),
+  expiration: z2.optional(z2.string({
+    description: "Expiration"
+  })),
+  memo: z2.optional(z2.string({
+    description: "Memo"
+  })),
+  evmTransactionDetails: z2.optional(EVMTransactionDetailsSchema),
+  routePathArray: z2.optional(z2.array(z2.string())),
+  estimatedTime: z2.optional(EstimatedTimeSchema),
+  totalSlippageBps: z2.number({
+    description: "Total slippage in bps"
+  }),
+  legs: z2.array(RouteQuoteLegSchema),
+  errorCode: z2.optional(z2.string()),
+  warnings: RouteQuoteWarningSchema,
+  meta: RouteQuoteMetadataSchema
+});
+var QuoteResponseRouteLegItem = z2.object({
+  provider: z2.nativeEnum(ProviderName),
+  sellAsset: z2.string({
+    description: "Asset to sell"
+  }),
+  sellAmount: z2.string({
+    description: "Sell amount"
+  }),
+  buyAsset: z2.string({
+    description: "Asset to buy"
+  }),
+  buyAmount: z2.string({
+    description: "Buy amount"
+  }),
+  buyAmountMaxSlippage: z2.string({
+    description: "Buy amount max slippage"
+  }),
+  fees: z2.optional(FeesSchema)
+});
+var QuoteResponseRouteItem = z2.object({
+  providers: z2.array(z2.nativeEnum(ProviderName)),
+  sellAsset: z2.string({
+    description: "Asset to sell"
+  }),
+  sellAmount: z2.string({
+    description: "sell amount"
+  }),
+  buyAsset: z2.string({
+    description: "Asset to buy"
+  }),
+  expectedBuyAmount: z2.string({
+    description: "Expected Buy amount"
+  }),
+  expectedBuyAmountMaxSlippage: z2.string({
+    description: "Expected Buy amount max slippage"
+  }),
+  sourceAddress: z2.string({
+    description: "Source address"
+  }),
+  destinationAddress: z2.string({
+    description: "Destination address"
+  }),
+  targetAddress: z2.optional(z2.string({
+    description: "Target address"
+  })),
+  expiration: z2.optional(z2.string({
+    description: "Expiration"
+  })),
+  memo: z2.optional(z2.string({
+    description: "Memo"
+  })),
+  evmTransactionDetails: z2.optional(EVMTransactionDetailsSchema),
+  estimatedTime: z2.optional(EstimatedTimeSchema),
+  totalSlippageBps: z2.number({
+    description: "Total slippage in bps"
+  }),
+  legs: z2.array(QuoteResponseRouteLegItem),
+  warnings: RouteQuoteWarningSchema,
+  meta: RouteQuoteMetadataSchema
+});
+var QuoteResponseSchema = z2.object({
+  quoteId: z2.string({
+    description: "Quote ID"
+  }),
+  routes: z2.array(QuoteResponseRouteItem),
+  error: z2.optional(z2.string({
+    description: "Error message"
+  }))
+});
 // src/modules/requestClient.ts
 import ky from "ky";
 function setRequestClientConfig({ apiKey, ...config }) {
@@ -1301,9 +1643,9 @@ var getKyClient = function() {
 };
 var kyClient;
 var defaultRequestHeaders = typeof window !== "undefined" ? {} : { referrer: "https://sk.thorswap.net", referer: "https://sk.thorswap.net" };
-var getTypedBaseRequestClient = (kyClient2) => ({
-  get: (url, options) => kyClient2.get(url, options).json(),
-  post: (url, options) => kyClient2.post(url, options).json()
+var getTypedBaseRequestClient = (ky2) => ({
+  get: (url, options) => ky2.get(url, options).json(),
+  post: (url, options) => ky2.post(url, options).json()
 });
 var RequestClient = {
   ...getTypedBaseRequestClient(getKyClient()),
@@ -1726,6 +2068,7 @@ var errorMessages = {
   wallet_ledger_device_locked: 20005,
   chainflip_channel_error: 30001,
   chainflip_broker_recipient_error: 30002,
+  api_v2_invalid_response: 40001,
   helpers_number_different_decimals: 99101
 };
 
@@ -2427,6 +2770,7 @@ export {
   assetFromString,
   addEVMWalletNetwork,
   addAccountsChangedCallback,
+  WarningCodeEnum,
   WalletOption,
   UTXOChains,
   TCSupportedChains,
@@ -2438,17 +2782,32 @@ export {
   SubstrateChains,
   SWAP_OUT,
   SWAP_IN,
+  RouteQuoteWarningSchema,
+  RouteQuoteSchema,
+  RouteQuoteMetadataSchema,
+  RouteQuoteMetadataAssetSchema,
+  RouteQuoteLegSchema,
+  RouteLegWithoutAddressesSchema,
+  RouteLegSchema,
   RequestClient,
   RPCUrl,
+  QuoteResponseSchema,
+  QuoteRequestSchema,
   QuoteMode,
+  ProviderName,
   NetworkDerivationPath,
   MemoType,
   MayaEthereumVaultAbi,
   MayaArbitrumVaultAbi,
   MAYASupportedChains,
   LedgerErrorCode,
+  FeesSchema,
+  FeeTypeEnum,
   FeeOption,
   ExplorerUrl,
+  EstimatedTimeSchema,
+  EVMTransactionDetailsSchema,
+  EVMTransactionDetailsParamsSchema,
   EVMChains,
   DerivationPath,
   CosmosChains,
@@ -2467,4 +2826,4 @@ export {
   AGG_SWAP
 };
 
-//# debugId=7D694DE433F7244B64756e2164756e21
+//# debugId=1AF616D9C1303CD064756e2164756e21