feat: allow custom rpc urls (#27)

scaffold-eth · Jan 20, 2025 · 08b7dc7 · 08b7dc7
1 parent df87df1
commit 08b7dc7
Show file tree

Hide file tree

Showing 9 changed files with 144 additions and 24 deletions.
diff --git a/.changeset/sixty-pans-visit.md b/.changeset/sixty-pans-visit.md
@@ -0,0 +1,5 @@
+---
+"burner-connector": patch
+---
+
+feat: allow custom rpc urls
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -23,7 +23,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 9.0.6
+          version: 9.14.2
 
       - name: Setup node env
         uses: actions/setup-node@v3

diff --git a/README.md b/README.md
@@ -24,16 +24,18 @@ or
 pnpm add burner-connector
 ```
 
-2. Using wagmi `burner` connector :
+2. Using wagmi `burner` connector:
 
 ```ts
 import { burner } from "burner-connector";
 import { mainnet, base } from "viem/chains";
 
-// burner function can also called with param `{ useSessionStorage: true }` to create a new wallet for each browser tab
-// - `useSessionStorage` to false (default) to persist wallet across browser tabs(incognito window will have different wallet)
-// - `useSessionStorage` to true to create a new wallet for each browser tab
+// Configuration options:
+// - `useSessionStorage` (optional) : false (default) to persist wallet across browser tabs
+//                       true to create a new wallet for each browser tab
+// - `rpcUrls` (optional) : custom RPC URLs for specific chain IDs
 
+// Basic usage without options
 export const config = createConfig({
   chains: [mainnet, base],
   connectors: [burner()],
@@ -42,6 +44,24 @@ export const config = createConfig({
     [base.id]: http(),
   },
 });
+
+// Example with all options
+export const config = createConfig({
+  chains: [mainnet, base],
+  connectors: [
+    burner({
+      useSessionStorage: true,
+      rpcUrls: {
+        1: "https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+        8453: "https://base-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+      },
+    }),
+  ],
+  transports: {
+    [mainnet.id]: http(),
+    [base.id]: http(),
+  },
+});
 ```
 
 3. Integrate with rainbowkit:
@@ -52,12 +72,17 @@ import { metaMaskWallet } from "@rainbow-me/rainbowkit/wallets";
 import { rainbowkitBurnerWallet } from "burner-connector";
 import { mainnet, base } from "viem/chains";
 
-const wallets = [metaMaskWallet, rainbowkitBurnerWallet];
+// Configure burner wallet options
+// Storage configuration:
+// - useSessionStorage: false (default) to persist wallet across browser tabs
+//                     true to create a new wallet for each browser tab
+rainbowkitBurnerWallet.useSessionStorage = true;
 
-// Configure burner wallet storage
-// - `useSessionStorage` to false (default) to persist wallet across browser tabs(incognito window will have different wallet)
-// - `useSessionStorage` to true to create a new wallet for each browser tab
-// rainbowkitBurnerWallet.useSessionStorage = true;
+// Custom RPC URLs configuration (optional):
+rainbowkitBurnerWallet.rpcUrls = {
+  1: "https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+  8453: "https://base-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+};
 
 const wallets = [metaMaskWallet, rainbowkitBurnerWallet];
 
@@ -85,6 +110,15 @@ const wagmiConfig = createConfig({
 });
 ```
 
+## Configuration Options
+
+### Burner Connector Options
+
+| Option                         | Type                     | Default     | Description                                                                                     |
+| ------------------------------ | ------------------------ | ----------- | ----------------------------------------------------------------------------------------------- |
+| `useSessionStorage` (optional) | `boolean`                | `false`     | When true, creates a new wallet for each browser tab. When false, persists wallet across tabs.  |
+| `rpcUrls` (optional)           | `Record<number, string>` | `undefined` | Optional custom RPC URLs for specific chain IDs. Falls back to chain's default if not provided. |
+
 ---
 
 Checkout [CONTRIBUTING.md](/CONTRIBUTING.md) for more details on how to set it up locally.
diff --git a/example/app/wagmiConfig.ts b/example/app/wagmiConfig.ts
@@ -8,6 +8,11 @@ import { rainbowkitBurnerWallet } from "burner-connector";
 // Use this if you want to enable session storage
 // rainbowkitBurnerWallet.useSessionStorage = true;
 
+/* Use custom RPC URLs to override wagmi's default RPC URLs if needed */
+/* rainbowkitBurnerWallet.rpcUrls = {
+  [optimismSepolia.id]: `https://opt-sepolia.g.alchemy.com/v2/${alchemyAPIKey}`,
+}; */
+
 const wallets = [metaMaskWallet, rainbowkitBurnerWallet];
 const walletConnectProjectID = "3a8170812b534d0ff9d794f19a901d64";
 const wagmiConnectors = connectorsForWallets(
@@ -21,7 +26,7 @@ const wagmiConnectors = connectorsForWallets(
   {
     appName: "scaffold-eth-2",
     projectId: walletConnectProjectID,
-  }
+  },
 );
 
 export const chains = [optimismSepolia, hardhat] as const;

diff --git a/package.json b/package.json
@@ -14,5 +14,6 @@
   "license": "MIT",
   "devDependencies": {
     "@changesets/cli": "^2.27.1"
-  }
+  },
+  "packageManager": "[email protected]+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"
 }
diff --git a/packages/burner-connector/README.md b/packages/burner-connector/README.md
@@ -16,11 +16,18 @@ or
 pnpm add burner-connector
 ```
 
-2. Using wagmi `burner` connector :
+2. Using wagmi `burner` connector:
 
 ```ts
 import { burner } from "burner-connector";
 import { mainnet, base } from "viem/chains";
+
+// Configuration options:
+// - `useSessionStorage` (optional) : false (default) to persist wallet across browser tabs
+//                       true to create a new wallet for each browser tab
+// - `rpcUrls` (optional) : custom RPC URLs for specific chain IDs
+
+// Basic usage without options
 export const config = createConfig({
   chains: [mainnet, base],
   connectors: [burner()],
@@ -29,6 +36,24 @@ export const config = createConfig({
     [base.id]: http(),
   },
 });
+
+// Example with all options
+export const config = createConfig({
+  chains: [mainnet, base],
+  connectors: [
+    burner({
+      useSessionStorage: true,
+      rpcUrls: {
+        1: "https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+        8453: "https://base-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+      },
+    }),
+  ],
+  transports: {
+    [mainnet.id]: http(),
+    [base.id]: http(),
+  },
+});
 ```
 
 3. Integrate with rainbowkit:
@@ -39,6 +64,18 @@ import { metaMaskWallet } from "@rainbow-me/rainbowkit/wallets";
 import { rainbowkitBurnerWallet } from "burner-connector";
 import { mainnet, base } from "viem/chains";
 
+// Configure burner wallet options
+// Storage configuration:
+// - useSessionStorage: false (default) to persist wallet across browser tabs
+//                     true to create a new wallet for each browser tab
+rainbowkitBurnerWallet.useSessionStorage = true;
+
+// Custom RPC URLs configuration (optional):
+rainbowkitBurnerWallet.rpcUrls = {
+  1: "https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+  8453: "https://base-mainnet.g.alchemy.com/v2/YOUR_API_KEY",
+};
+
 const wallets = [metaMaskWallet, rainbowkitBurnerWallet];
 
 const wagmiConnectors = connectorsForWallets(
@@ -64,3 +101,16 @@ const wagmiConfig = createConfig({
   },
 });
 ```
+
+## Configuration Options
+
+### Burner Connector Options
+
+| Option                         | Type                     | Default     | Description                                                                                     |
+| ------------------------------ | ------------------------ | ----------- | ----------------------------------------------------------------------------------------------- |
+| `useSessionStorage` (optional) | `boolean`                | `false`     | When true, creates a new wallet for each browser tab. When false, persists wallet across tabs.  |
+| `rpcUrls` (optional)           | `Record<number, string>` | `undefined` | Optional custom RPC URLs for specific chain IDs. Falls back to chain's default if not provided. |
+
+---
+
+Checkout [CONTRIBUTING.md](/CONTRIBUTING.md) for more details on how to set it up locally.
diff --git a/packages/burner-connector/src/burnerConnector/burner.ts b/packages/burner-connector/src/burnerConnector/burner.ts
@@ -30,7 +30,12 @@ export class ChainNotConfiguredError extends BaseError {
 
 type Provider = ReturnType<Transport<"custom", Record<any, any>, EIP1193RequestFn<WalletRpcSchema>>>;
 
-export const burner = ({ useSessionStorage = false }: { useSessionStorage?: boolean } = {}) => {
+type BurnerConfig = {
+  useSessionStorage?: boolean;
+  rpcUrls?: Record<number, string>;
+};
+
+export const burner = ({ useSessionStorage = false, rpcUrls = {} }: BurnerConfig = {}) => {
   let connected = true;
   let connectedChainId: number;
   return createConnector<Provider>((config) => ({
@@ -53,13 +58,15 @@ export const burner = ({ useSessionStorage = false }: { useSessionStorage?: bool
     async getProvider({ chainId } = {}) {
       const chain = config.chains.find((x) => x.id === chainId) ?? config.chains[0];
 
-      const url = chain.rpcUrls.default.http[0];
+      // Use custom RPC URL if provided, otherwise fallback to default
+      const url = rpcUrls[chain.id] || chain.rpcUrls.default.http[0];
       if (!url) throw new Error("No rpc url found for chain");
+
       const burnerAccount = privateKeyToAccount(loadBurnerPK({ useSessionStorage }));
       const client = createWalletClient({
         chain: chain,
         account: burnerAccount,
-        transport: http(),
+        transport: http(url),
       });
 
       const request: EIP1193RequestFn = async ({ method, params }) => {

diff --git a/packages/burner-connector/src/wallets/rainbowkit/rainbowkitBurnerConnector.ts b/packages/burner-connector/src/wallets/rainbowkit/rainbowkitBurnerConnector.ts
@@ -5,16 +5,22 @@ import { burner } from "../../burnerConnector/burner.js";
 
 type Provider = ReturnType<Transport<"custom", Record<any, any>, EIP1193RequestFn<WalletRpcSchema>>>;
 
-export const rainbowkitBurnerConnector = (walletDetails: WalletDetailsParams) => {
+export const rainbowkitBurnerConnector = (
+  walletDetails: WalletDetailsParams,
+  burnerWalletConfig: { rpcUrls?: Record<number, string> },
+) => {
   return createConnector<Provider>((config) => ({
-    ...burner()(config),
+    ...burner({ rpcUrls: burnerWalletConfig?.rpcUrls })(config),
     ...walletDetails,
   }));
 };
 
-export const rainbowkitSessionStorageBurnerConnector = (walletDetails: WalletDetailsParams) => {
+export const rainbowkitSessionStorageBurnerConnector = (
+  walletDetails: WalletDetailsParams,
+  burnerWalletConfig: { rpcUrls?: Record<number, string> },
+) => {
   return createConnector<Provider>((config) => ({
-    ...burner({ useSessionStorage: true })(config),
+    ...burner({ useSessionStorage: true, rpcUrls: burnerWalletConfig?.rpcUrls })(config),
     ...walletDetails,
   }));
 };
diff --git a/packages/burner-connector/src/wallets/rainbowkit/rainbowkitBurnerWallet.ts b/packages/burner-connector/src/wallets/rainbowkit/rainbowkitBurnerWallet.ts
@@ -1,4 +1,4 @@
-import type { Wallet } from "@rainbow-me/rainbowkit";
+import type { Wallet, WalletDetailsParams } from "@rainbow-me/rainbowkit";
 import { burnerWalletId, burnerWalletName } from "../../utils/index.js";
 import { rainbowkitBurnerConnector, rainbowkitSessionStorageBurnerConnector } from "./rainbowkitBurnerConnector.js";
 
@@ -8,6 +8,7 @@ const burnerWalletIconBase64 =
 type RainbowkitBurnerWallet = {
   (): Wallet;
   useSessionStorage?: boolean;
+  rpcUrls?: Record<number, string>;
 };
 
 /**
@@ -18,7 +19,18 @@ export const rainbowkitBurnerWallet: RainbowkitBurnerWallet = () => ({
   name: burnerWalletName,
   iconUrl: burnerWalletIconBase64,
   iconBackground: "#ffffff",
-  createConnector: rainbowkitBurnerWallet.useSessionStorage
-    ? rainbowkitSessionStorageBurnerConnector
-    : rainbowkitBurnerConnector,
+  createConnector: (params: WalletDetailsParams) => {
+    const connector = rainbowkitBurnerWallet.useSessionStorage
+      ? rainbowkitSessionStorageBurnerConnector
+      : rainbowkitBurnerConnector;
+
+    return connector(
+      {
+        ...params,
+      },
+      {
+        rpcUrls: rainbowkitBurnerWallet.rpcUrls,
+      },
+    );
+  },
 });