Merge pull request #3 from BootNodeDev/feat/usePool

feat: getPool/useGetPool

Author: luchobonatti

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
+    branches: ["*"]
 
 jobs:
   build-and-test:

README.md

@@ -4,70 +4,99 @@
 [![Release](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/release.yml/badge.svg)](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/release.yml)
 [![Docs](https://img.shields.io/badge/docs-typedoc-blue)](https://bootnodedev.github.io/uni-dev-kit)
 
-A modern TypeScript library for integrating Uniswap V4 into your dapp.
+> Modern TypeScript SDK for integrating Uniswap V4 into your dapp.  
+> **Early version:** API may change rapidly.
 
-## Installation
+---
+
+## Install
 
 ```bash
 pnpm install uniswap-dev-kit
+# or
+npm install uniswap-dev-kit
 ```
 
 ## Quick Start
 
-### 1. Configure and create an SDK instance
+### 1. Configure and create SDK instances
 
 ```ts
-import { createInstance } from 'uniswap-dev-kit';
+import { createInstance } from "uniswap-dev-kit";
 
-const config = {
+// Create instance for Ethereum mainnet
+createInstance({
   chainId: 1,
-  rpcUrl: 'https://eth.llamarpc.com',
+  rpcUrl: "https://eth.llamarpc.com",
   contracts: {
-    poolManager: '0x...',
-    positionDescriptor: '0x...',
-    positionManager: '0x...',
-    quoter: '0x...',
-    stateView: '0x...',
-    universalRouter: '0x...',
-    permit2: '0x...'
+    poolManager: "0x...",
+    positionDescriptor: "0x...",
+    positionManager: "0x...",
+    quoter: "0x...",
+    stateView: "0x...",
+    universalRouter: "0x...",
+    permit2: "0x..."
   }
-};
+});
 
-createInstance(config);
+// Create instance for another chain (e.g., Base)
+createInstance({
+  chainId: 8453,
+  rpcUrl: "https://mainnet.base.org",
+  contracts: {
+    // Base Uniswap V4 contract addresses...
+  }
+});
 ```
 
-### 2. Use the getQuote function (vanilla JS/TS)
+The SDK automatically manages multiple instances based on chainId. When using hooks or utilities, just specify the chainId to use the corresponding instance:
 
 ```ts
-import { getQuote } from 'uniswap-dev-kit';
-import { parseEther } from 'viem';
-
-const quote = await getQuote({
-  tokens: [
-    "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
-    "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"  // WETH
-  ],
-  feeTier: 3000,
-  tickSpacing: 60,
-  amountIn: parseEther("1"), // 1 ETH in wei
-  zeroForOne: true
-});
+// Will use Ethereum mainnet instance
+const ethPool = await getPool({ tokens: [...] }, 1);
+
+// Will use Base instance
+const basePool = await getPool({ tokens: [...] }, 8453);
+
+// If you only have one instance, chainId is optional
+const singleChainPool = await getPool({ tokens: [...] });
+```
+
+### 2. Get a quote (vanilla JS/TS)
+
+```ts
+import { getQuote } from "uniswap-dev-kit";
+import { parseEther } from "viem";
+
+const quote = await getQuote(
+  {
+    tokens: [
+      "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+      "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
+    ],
+    feeTier: 3000,
+    tickSpacing: 60,
+    amountIn: parseEther("1"),
+  },
+  1,
+  {
+    enabled: true,
+    staleTime: 30000,
+    gcTime: 300000,
+    retry: 3,
+    onSuccess: (data) => console.log("Quote received:", data),
+  },
+);
 console.log(quote.amountOut);
 ```
 
-**Parameters of getQuote:**
-- `tokens`: `[tokenA, tokenB]` (addresses)
-- `feeTier`: pool fee (e.g. 3000)
-- `tickSpacing`: pool tick spacing (e.g. 60)
-- `amountIn`: amount to swap (bigint, e.g. `parseEther("1")`)
-- `zeroForOne`: swap direction (true: tokenA→tokenB)
-- `hooks` and `hookData`: optional
+### 3. Use in React (with hooks)
 
-### 3. Use the useGetQuote hook (React)
+#### Get a quote
 
 ```tsx
-import { useGetQuote } from 'uniswap-dev-kit';
-import { parseEther } from 'viem';
+import { useGetQuote } from "uniswap-dev-kit";
+import { parseEther } from "viem";
 
 function QuoteComponent() {
   const { data, isLoading, error } = useGetQuote({
@@ -80,7 +109,8 @@ function QuoteComponent() {
       tickSpacing: 60,
       amountIn: parseEther("1"),
       zeroForOne: true
-    }
+    },
+    chainId: 1
   });
 
   if (isLoading) return <span>Loading...</span>;
@@ -89,10 +119,74 @@ function QuoteComponent() {
 }
 ```
 
-## Documentation
+#### Get a pool
+
+```tsx
+import { useGetPool } from "uniswap-dev-kit";
+
+function PoolComponent() {
+  const { data, isLoading, error } = useGetPool({
+    params: {
+      tokens: [
+        "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
+      ],
+      fee: 3000,
+    },
+    chainId: 1
+  });
+
+  if (isLoading) return <span>Loading...</span>;
+  if (error) return <span>Error: {error.message}</span>;
+  return <span>Pool: {JSON.stringify(data)}</span>;
+}
+```
+
+---
+
+## API Reference
+
+See [full TypeDoc documentation](https://bootnodedev.github.io/uni-dev-kit) for all methods, types, and advanced usage.
+
+---
+
+## Development
+
+### Scripts
+
+- `pnpm build` — Build the library
+- `pnpm test` — Run all tests
+- `pnpm lint` — Lint code with Biome
+- `pnpm format` — Format code with Biome
+- `pnpm docs` — Generate API docs with TypeDoc
+
+### Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
+
+### Release
+
+- Releases are automated with [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
+- Versioning: [semver](https://semver.org/)
+
+---
+
+## FAQ
+
+- **Which React versions are supported?**  
+  React 18+ (see peerDependencies)
+- **Does it work in Node and browser?**  
+  Yes, but hooks are React-only.
+- **Can I use my own ABIs?**  
+  Yes, but Uniswap V4 ABIs are included.
+
+---
+
+## License
 
-See [API Documentation](https://bootnodedev.github.io/uni-dev-kit) for full API reference.
+MIT
 
 ---
 
-> This is an early version. API and features will evolve rapidly. 
+> Feedback, issues, and PRs welcome.  
+> [API Docs](https://bootnodedev.github.io/uni-dev-kit) • [Open an Issue](https://github.com/BootNodeDev/uni-dev-kit/issues) 

package.json

@@ -83,7 +83,8 @@
     "@uniswap/sdk-core": "^7.7.2",
     "@uniswap/v3-sdk": "^3.25.2",
     "@uniswap/v4-sdk": "^1.21.4",
-    "ethers": "^6.0.0",
+    "ethers": "^5.7.2",
+    "jsbi": "^3.2.5",
     "viem": "^2.29.2",
     "wagmi": "^2.15.2"
   }