chore: initial release setup

Author: luchobonatti

.github/workflows/docs.yml

@@ -28,7 +28,7 @@ jobs:
       run: pnpm install
 
     - name: Build docs
-      run: pnpm docs
+      run: pnpm run docs
 
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v3

.github/workflows/release.yml

@@ -9,16 +9,27 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: 'https://registry.npmjs.org/'
+
       - name: Install pnpm
         run: npm install -g pnpm
-      - run: pnpm install
-      - run: pnpm run build
-      - run: npx semantic-release --no-ci
+        
+      - name: Install Dependencies
+        run: pnpm install
+        
+      - name: Build Package
+        run: pnpm run build
+        
+      - name: Run Semantic Release
+        run: npx semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          CI: true

.npmrc

@@ -1,2 +1,2 @@
 //registry.npmjs.org/:_authToken=${NPM_TOKEN}
-access=public 
+access=public

.releaserc.json

@@ -1,13 +1,29 @@
 {
   "branches": ["main"],
+  "tagFormat": "v${version}",
+  "release": {
+    "initialVersion": "0.0.1"
+  },
   "plugins": [
-    "@semantic-release/commit-analyzer",
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "releaseRules": [
+          { "type": "*", "release": "patch" }
+        ],
+        "parserOpts": {
+          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
+        }
+      }
+    ],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",
-    "@semantic-release/npm",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
     "@semantic-release/github"
-  ],
-  "release": {
-    "initialVersion": "0.0.1"
-  }
+  ]
 }

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to uni-dev-kit
+# Contributing to uniswap-dev-kit
 
 Thanks for your interest in contributing! Here's how to get started:
 

README.md

@@ -1,27 +1,92 @@
-# uni-dev-kit
+# uniswap-dev-kit
 
 [![CI](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/ci.yml)
 [![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://github.com/BootNodeDev/uni-dev-kit/tree/main/docs)
+[![Docs](https://img.shields.io/badge/docs-typedoc-blue)](https://bootnodedev.github.io/uni-dev-kit)
 
-A modern TypeScript library for integrating Uniswap into your dapp.
+A modern TypeScript library for integrating Uniswap V4 into your dapp.
 
 ## Installation
 
 ```bash
-pnpm install uni-dev-kit
+pnpm install uniswap-dev-kit
 ```
 
-## Usage
+## Quick Start
+
+### 1. Configure and create an SDK instance
+
+```ts
+import { createInstance } from 'uniswap-dev-kit';
+
+const config = {
+  chainId: 1,
+  rpcUrl: 'https://eth.llamarpc.com',
+  contracts: {
+    poolManager: '0x...',
+    positionDescriptor: '0x...',
+    positionManager: '0x...',
+    quoter: '0x...',
+    stateView: '0x...',
+    universalRouter: '0x...',
+    permit2: '0x...'
+  }
+};
+
+createInstance(config);
+```
+
+### 2. Use the getQuote function (vanilla JS/TS)
 
 ```ts
-import { useUniswap, someFunction } from 'uni-dev-kit';
+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
+});
+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 the useGetQuote hook (React)
+
+```tsx
+import { useGetQuote } from 'uniswap-dev-kit';
+import { parseEther } from 'viem';
 
-// Example React hook usage
-const result = useUniswap(/* params */);
+function QuoteComponent() {
+  const { data, isLoading, error } = useGetQuote({
+    params: {
+      tokens: [
+        "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
+      ],
+      feeTier: 3000,
+      tickSpacing: 60,
+      amountIn: parseEther("1"),
+      zeroForOne: true
+    }
+  });
 
-// Example function usage
-const data = someFunction(/* params */);
+  if (isLoading) return <span>Loading...</span>;
+  if (error) return <span>Error: {error.message}</span>;
+  return <span>Quote: {data?.amountOut?.toString()}</span>;
+}
 ```
 
 ## Documentation

biome.json

@@ -8,6 +8,7 @@
 		}
 	},
 	"files": {
-		"include": ["src/**/*", "test/**/*"]
+		"include": ["src/**/*", "test/**/*"],
+		"ignore": ["dist/**/*"]
 	}
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "uni-dev-kit",
+  "name": "uniswap-dev-kit",
   "version": "0.0.1",
   "description": "A modern TypeScript library for integrating Uniswap into your dapp.",
   "main": "dist/index.js",
@@ -10,7 +10,9 @@
       "require": "./dist/index.js"
     }
   },
-  "files": ["dist/**/*"],
+  "files": [
+    "dist/**/*"
+  ],
   "scripts": {
     "dev": "tsc --watch",
     "build": "npm run clean && tsc && tsc-alias",
@@ -43,6 +45,10 @@
   ],
   "author": "BootNodeDev",
   "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "peerDependencies": {
     "@tanstack/react-query": "^5.0.0",
     "react": "^18.0.0",

tsconfig.json

@@ -24,5 +24,5 @@
     },
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules", "dist", "docs"]
 }

vitest.config.ts

@@ -1,11 +1,21 @@
+import path from "path";
 import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
     environment: "jsdom",
     globals: true,
     alias: {
-      "@": "/src",
+      "@": path.resolve(__dirname, "src"),
     },
+    exclude: ["node_modules", "dist", ".git", ".cache"],
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "json", "html"],
+      include: ["src/**/*.ts"],
+      exclude: ["src/**/*.test.ts"],
+      all: true,
+    },
+    clearMocks: true,
   },
-}); 
+});