@gearbox-protocol/sdk 4.0.3 → 4.1.1

package/dist/cjs/dev/createTransport.js

@@ -0,0 +1,63 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var createTransport_exports = {};
+__export(createTransport_exports, {
+  createTransport: () => createTransport,
+  getAlchemyHttpUrl: () => getAlchemyHttpUrl,
+  getAlchemyUrl: () => getAlchemyUrl,
+  getAlchemyWsUrl: () => getAlchemyWsUrl
+});
+module.exports = __toCommonJS(createTransport_exports);
+var import_viem = require("viem");
+var import_sdk = require("../sdk/index.js");
+function createTransport(config) {
+  const { alchemyKeys, protocol, network, ...rest } = config;
+  const rpcUrls = config.rpcUrls.filter((url) => {
+    return url.startsWith(protocol) && !alchemyKeys.some((key) => url.includes(key));
+  });
+  const { alchemyDomain } = (0, import_sdk.getChain)(network);
+  if (alchemyDomain) {
+    rpcUrls.unshift(
+      ...alchemyKeys.map((key) => getAlchemyUrl(alchemyDomain, key, protocol))
+    );
+  }
+  const transports = rpcUrls.map(
+    (url) => protocol === "http" ? (0, import_viem.http)(url, rest) : (0, import_viem.webSocket)(url, rest)
+  );
+  if (transports.length === 0) {
+    throw new Error("no fitting rpc urls found");
+  }
+  return transports.length > 1 ? (0, import_viem.fallback)(transports) : transports[0];
+}
+function getAlchemyUrl(domain, apiKey, protocol) {
+  return protocol === "http" ? getAlchemyHttpUrl(domain, apiKey) : getAlchemyWsUrl(domain, apiKey);
+}
+function getAlchemyHttpUrl(domain, apiKey) {
+  return `https://${domain}.g.alchemy.com/v2/${apiKey}`;
+}
+function getAlchemyWsUrl(domain, apiKey) {
+  return `wss://${domain}.g.alchemy.com/v2/${apiKey}`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createTransport,
+  getAlchemyHttpUrl,
+  getAlchemyUrl,
+  getAlchemyWsUrl
+});

package/dist/cjs/dev/index.js

@@ -19,6 +19,7 @@ __reExport(dev_exports, require("./AccountOpener.js"), module.exports);
 __reExport(dev_exports, require("./calcLiquidatableLTs.js"), module.exports);
 __reExport(dev_exports, require("./create2.js"), module.exports);
 __reExport(dev_exports, require("./createAnvilClient.js"), module.exports);
+__reExport(dev_exports, require("./createTransport.js"), module.exports);
 __reExport(dev_exports, require("./detectChain.js"), module.exports);
 __reExport(dev_exports, require("./migrateFaucet.js"), module.exports);
 __reExport(dev_exports, require("./PriceFeedStore.js"), module.exports);
@@ -30,6 +31,7 @@ __reExport(dev_exports, require("./setLTZero.js"), module.exports);
   ...require("./calcLiquidatableLTs.js"),
   ...require("./create2.js"),
   ...require("./createAnvilClient.js"),
+  ...require("./createTransport.js"),
   ...require("./detectChain.js"),
   ...require("./migrateFaucet.js"),
   ...require("./PriceFeedStore.js"),

package/dist/cjs/sdk/chain/chains.js

@@ -70,7 +70,8 @@ const chains = {
       wellKnownToken: {
         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "eth-mainnet"
     },
     "ethereum-rpc"
   ),
@@ -85,7 +86,8 @@ const chains = {
       wellKnownToken: {
         address: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "arb-mainnet"
     },
     "arbitrum-one-rpc"
   ),
@@ -100,7 +102,8 @@ const chains = {
       wellKnownToken: {
         address: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "opt-mainnet"
     },
     "optimism-rpc"
   ),
@@ -113,7 +116,8 @@ const chains = {
       wellKnownToken: {
         address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "base-mainnet"
     },
     "base-rpc"
   ),
@@ -135,7 +139,8 @@ const chains = {
       wellKnownToken: {
         address: "0x29219dd400f2Bf60E5a23d13Be72B486D4038894",
         symbol: "USDC.e"
-      }
+      },
+      alchemyDomain: "sonic-mainnet"
     }),
     "sonic-rpc"
   ),
@@ -160,8 +165,9 @@ const chains = {
     wellKnownToken: {
       address: "0xf817257fed379853cDe0fa4F97AB987181B1E5Ea",
       symbol: "USDC"
-    }
+    },
     // TODO: has no block explorer API
+    alchemyDomain: "monad-testnet"
   }),
   Berachain: withPublicNode(
     {
@@ -179,7 +185,8 @@ const chains = {
       wellKnownToken: {
         address: "0x549943e04f40284185054145c6e4e9568c1d3241",
         symbol: "USDC.e"
-      }
+      },
+      alchemyDomain: "berachain-mainnet"
     },
     "berachain-rpc"
   ),
@@ -192,7 +199,8 @@ const chains = {
       wellKnownToken: {
         address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "avax-mainnet"
     },
     "avalanche-c-chain-rpc"
   ),
@@ -210,7 +218,8 @@ const chains = {
       wellKnownToken: {
         address: "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "bnb-mainnet"
     },
     "bsc-rpc"
   ),
@@ -222,7 +231,8 @@ const chains = {
     wellKnownToken: {
       address: "0x79a02482a880bce3f13e09da970dc34db4cd24d1",
       symbol: "USDC.e"
-    }
+    },
+    alchemyDomain: "worldchain-mainnet"
     // TODO: has no block explorer API
   })
 };

package/dist/esm/dev/createTransport.js

@@ -0,0 +1,36 @@
+import { fallback, http, webSocket } from "viem";
+import { getChain } from "../sdk/index.js";
+function createTransport(config) {
+  const { alchemyKeys, protocol, network, ...rest } = config;
+  const rpcUrls = config.rpcUrls.filter((url) => {
+    return url.startsWith(protocol) && !alchemyKeys.some((key) => url.includes(key));
+  });
+  const { alchemyDomain } = getChain(network);
+  if (alchemyDomain) {
+    rpcUrls.unshift(
+      ...alchemyKeys.map((key) => getAlchemyUrl(alchemyDomain, key, protocol))
+    );
+  }
+  const transports = rpcUrls.map(
+    (url) => protocol === "http" ? http(url, rest) : webSocket(url, rest)
+  );
+  if (transports.length === 0) {
+    throw new Error("no fitting rpc urls found");
+  }
+  return transports.length > 1 ? fallback(transports) : transports[0];
+}
+function getAlchemyUrl(domain, apiKey, protocol) {
+  return protocol === "http" ? getAlchemyHttpUrl(domain, apiKey) : getAlchemyWsUrl(domain, apiKey);
+}
+function getAlchemyHttpUrl(domain, apiKey) {
+  return `https://${domain}.g.alchemy.com/v2/${apiKey}`;
+}
+function getAlchemyWsUrl(domain, apiKey) {
+  return `wss://${domain}.g.alchemy.com/v2/${apiKey}`;
+}
+export {
+  createTransport,
+  getAlchemyHttpUrl,
+  getAlchemyUrl,
+  getAlchemyWsUrl
+};

package/dist/esm/dev/index.js

@@ -2,6 +2,7 @@ export * from "./AccountOpener.js";
 export * from "./calcLiquidatableLTs.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";
+export * from "./createTransport.js";
 export * from "./detectChain.js";
 export * from "./migrateFaucet.js";
 export * from "./PriceFeedStore.js";

package/dist/esm/sdk/chain/chains.js

@@ -53,7 +53,8 @@ const chains = {
       wellKnownToken: {
         address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "eth-mainnet"
     },
     "ethereum-rpc"
   ),
@@ -68,7 +69,8 @@ const chains = {
       wellKnownToken: {
         address: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "arb-mainnet"
     },
     "arbitrum-one-rpc"
   ),
@@ -83,7 +85,8 @@ const chains = {
       wellKnownToken: {
         address: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "opt-mainnet"
     },
     "optimism-rpc"
   ),
@@ -96,7 +99,8 @@ const chains = {
       wellKnownToken: {
         address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "base-mainnet"
     },
     "base-rpc"
   ),
@@ -118,7 +122,8 @@ const chains = {
       wellKnownToken: {
         address: "0x29219dd400f2Bf60E5a23d13Be72B486D4038894",
         symbol: "USDC.e"
-      }
+      },
+      alchemyDomain: "sonic-mainnet"
     }),
     "sonic-rpc"
   ),
@@ -143,8 +148,9 @@ const chains = {
     wellKnownToken: {
       address: "0xf817257fed379853cDe0fa4F97AB987181B1E5Ea",
       symbol: "USDC"
-    }
+    },
     // TODO: has no block explorer API
+    alchemyDomain: "monad-testnet"
   }),
   Berachain: withPublicNode(
     {
@@ -162,7 +168,8 @@ const chains = {
       wellKnownToken: {
         address: "0x549943e04f40284185054145c6e4e9568c1d3241",
         symbol: "USDC.e"
-      }
+      },
+      alchemyDomain: "berachain-mainnet"
     },
     "berachain-rpc"
   ),
@@ -175,7 +182,8 @@ const chains = {
       wellKnownToken: {
         address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "avax-mainnet"
     },
     "avalanche-c-chain-rpc"
   ),
@@ -193,7 +201,8 @@ const chains = {
       wellKnownToken: {
         address: "0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d",
         symbol: "USDC"
-      }
+      },
+      alchemyDomain: "bnb-mainnet"
     },
     "bsc-rpc"
   ),
@@ -205,7 +214,8 @@ const chains = {
     wellKnownToken: {
       address: "0x79a02482a880bce3f13e09da970dc34db4cd24d1",
       symbol: "USDC.e"
-    }
+    },
+    alchemyDomain: "worldchain-mainnet"
     // TODO: has no block explorer API
   })
 };

package/dist/types/dev/createTransport.d.ts

@@ -0,0 +1,24 @@
+import type { HttpTransportConfig, Transport, WebSocketTransportConfig } from "viem";
+import type { NetworkType } from "../sdk/index.js";
+export interface CreateTransportURLOptions {
+    rpcUrls: string[];
+    alchemyKeys: string[];
+    network: NetworkType;
+}
+export type CreateHTTPTransportConfig = {
+    protocol: "http";
+} & HttpTransportConfig & CreateTransportURLOptions;
+export type CreateWSTransportConfig = {
+    protocol: "ws";
+} & WebSocketTransportConfig & CreateTransportURLOptions;
+export type CreateTransportConfig = CreateHTTPTransportConfig | CreateWSTransportConfig;
+/**
+ * Helper method to create viem Transport using API keys of well-known RPC providers and explicit fallback URLs
+ * Currently only supports Alchemy
+ * @param config
+ * @returns
+ */
+export declare function createTransport(config: CreateTransportConfig): Transport;
+export declare function getAlchemyUrl(domain: string, apiKey: string, protocol: "http" | "ws"): string;
+export declare function getAlchemyHttpUrl(domain: string, apiKey: string): string;
+export declare function getAlchemyWsUrl(domain: string, apiKey: string): string;

package/dist/types/dev/index.d.ts

@@ -2,6 +2,7 @@ export * from "./AccountOpener.js";
 export * from "./calcLiquidatableLTs.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";
+export * from "./createTransport.js";
 export * from "./detectChain.js";
 export * from "./migrateFaucet.js";
 export * from "./PriceFeedStore.js";

package/dist/types/sdk/chain/chains.d.ts

@@ -18,6 +18,10 @@ export interface GearboxChain extends Chain {
         address: Address;
         symbol: string;
     };
+    /**
+     * Alchemy subdomain to construct provider URL
+     */
+    alchemyDomain?: string;
 }
 export declare const SUPPORTED_NETWORKS: readonly ["Mainnet", "Arbitrum", "Optimism", "Base", "Sonic", "MegaETH", "Monad", "Berachain", "Avalanche", "BNB", "WorldChain"];
 export declare const NetworkType: z.ZodEnum<["Mainnet", "Arbitrum", "Optimism", "Base", "Sonic", "MegaETH", "Monad", "Berachain", "Avalanche", "BNB", "WorldChain"]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",