@swapkit/helpers - npm Package Compare versions

Comparing version 1.0.0-rc.101 to 1.0.0-rc.102

package.json

@@ -5,3 +5,4 @@ {
   "dependencies": {
-    "ky": "1.2.3"
+    "ky": "1.2.3",
+    "zod": "3.23.8"
   },
@@ -15,3 +16,4 @@ "devDependencies": {
     "@swapkit/tokens": "1.0.0-rc.52",
-    "ky": "1.2.3"
+    "ky": "1.2.3",
+    "zod": "3.23.8"
   },
@@ -41,3 +43,3 @@ "files": [
   "types": "./src/index.ts",
-  "version": "1.0.0-rc.101"
+  "version": "1.0.0-rc.102"
 }

src/modules/requestClient.ts

@@ -24,6 +24,5 @@ import type { KyInstance, Options } from "ky";
 
-const getTypedBaseRequestClient = (kyClient: KyInstance) => ({
-  get: <T>(url: string | URL | Request, options?: Options) => kyClient.get(url, options).json<T>(),
-  post: <T>(url: string | URL | Request, options?: Options) =>
-    kyClient.post(url, options).json<T>(),
+const getTypedBaseRequestClient = (ky: KyInstance) => ({
+  get: <T>(url: string | URL | Request, options?: Options) => ky.get(url, options).json<T>(),
+  post: <T>(url: string | URL | Request, options?: Options) => ky.post(url, options).json<T>(),
 });
@@ -30,0 +29,0 @@

src/modules/swapKitError.ts

@@ -77,2 +77,7 @@ const errorMessages = {
   /**
+   * SwapKit API
+   */
+  api_v2_invalid_response: 40001,
+
+  /**
    * Helpers
@@ -79,0 +84,0 @@ */

src/types/index.ts

@@ -11,1 +11,2 @@ export * from "./abis/erc20";
 export * from "./sdk";
+export * from "./quotes";

src/types/sdk.ts

@@ -0,11 +1,15 @@
+import { z } from "zod";
 import type { AssetValue } from "../modules/assetValue";
+import type { QuoteResponseRoute } from "./quotes";
 
 export type GenericSwapParams = {
-  buyAsset: AssetValue;
-  sellAsset: AssetValue;
-  recipient: string;
+  buyAsset?: AssetValue;
+  sellAsset?: AssetValue;
+  recipient?: string;
+  feeOptionKey?: FeeOption;
+  route: QuoteResponseRoute;
 };
 
 export type SwapParams<PluginNames = string, T = GenericSwapParams> = T & {
-  pluginName: PluginNames;
+  pluginName?: PluginNames;
 };
@@ -45,1 +49,79 @@
 }
+
+export const 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"],
+  });
+
+export type QuoteRequest = z.infer<typeof QuoteRequestSchema>;

No alert changes

Improved metrics

Total package byte prevSize

450931

increased by10.18%

Number of package files

36

increased by2.86%

Lines of code

7518

increased by12.03%

Worsened metrics

Dependency count

5

increased by66.67%

Dependency changes

• + Addedzod@3.23.8

• + Addedzod@3.23.8(transitive)