Merge pull request #2 from SailFish-Finance/feat-ui-for-bridge

Feat UI for bridge

Author: olulofe

Diff for: .gitignore

@@ -37,4 +37,10 @@ coverage/
 
 # System files
 Thumbs.db
-Desktop.ini
+Desktop.ini
+
+examples/nextjs-test-sdk/.next/
+examples/nextjs-test-sdk/out/
+examples/nextjs-test-sdk/node_modules/
+examples/nextjs-test-sdk/.env
+examples/nextjs-test-sdk/.env.local

Diff for: README.md

@@ -19,6 +19,7 @@ npm install @sailfishdex/v3-sdk
 - **Multi-hop Support**: Full support for multi-hop routes
 - **Token Approval**: Methods for checking and approving token allowances
 - **Token Bridging**: Bridge EDU tokens between BSC, Arbitrum, and EDUCHAIN
+- **UI Components**: Ready-to-use React components for token bridging
 
 ## Usage
 
@@ -338,6 +339,7 @@ The SDK includes several examples in the `examples` directory:
 - **multihop-wiser-esd.js**: Specific example of a multi-hop swap between WISER and ESD tokens using WEDU as an intermediary token
 - **bridge-edu.js**: Shows how to bridge EDU tokens from BSC to Arbitrum using LayerZero
 - **bridge-arb-to-edu.js**: Shows how to bridge EDU tokens from Arbitrum to EDUCHAIN
+- **bridge-widget-usage.js**: Demonstrates how to use the BridgeWidget React component in a web application
 
 ## Contract Addresses
 

Diff for: examples/bridge-arb-to-edu.js

@@ -1,11 +1,11 @@
 // Example of bridging EDU tokens from Arbitrum to EDUCHAIN
 
 const { ethers } = require("ethers");
-const { Bridge } = require("../dist");
+const { Bridge } = require("../dist/index.cjs");
 
 // This example requires a private key to sign transactions
 // Replace with your own private key and NEVER share it or commit it to version control
-const PRIVATE_KEY = '';
+const PRIVATE_KEY = 'PRIVATE_KEY';
 
 async function main() {
   try {

Diff for: examples/bridge-edu.js

@@ -1,7 +1,7 @@
 // Example of bridging EDU tokens from BSC to Arbitrum using LayerZero
 
 const { ethers } = require("ethers");
-const { Bridge } = require("../dist");
+const { Bridge } = require("../dist/index.cjs");
 
 // This example requires a private key to sign transactions
 // Replace with your own private key and NEVER share it or commit it to version control

Diff for: examples/execute-swap-singleswap.js

@@ -1,7 +1,7 @@
 // Example of executing a swap using the SailFish DEX v3 SDK
 
 const { ethers } = require("ethers");
-const { Quoter, Router, TradeType } = require("../dist");
+const { Quoter, Router, TradeType } = require("../dist/index.cjs");
 
 // This example requires a private key to sign transactions
 // Replace with your own private key and NEVER share it or commit it to version control

Diff for: examples/get-quote-multiswap.js

@@ -1,7 +1,7 @@
 // Example of multi-hop swaps using the SailFish DEX v3 SDK
 
 const { ethers } = require("ethers");
-const { Quoter, Router, TradeType } = require("../dist");
+const { Quoter, Router, TradeType } = require("../dist/index.cjs");
 
 async function main() {
   try {
@@ -66,36 +66,9 @@ async function main() {
 
       // For multi-hop routes, we can also demonstrate how to execute them
       if (bestRoute.type === "indirect") {
-        console.log("\nTo execute this multi-hop swap, see multihop-wiser-esd.js in examples folder.");
-        // console.log("1. Create a path by encoding the tokens and fees");
-        // console.log(
-        //   "2. Use the router.exactInput method instead of exactInputSingle"
-        // );
-
-        // Example code for creating the path (not executed)
-        //         console.log("\nExample code:");
-        //         console.log(`
-        // const path = ethers.solidityPacked(
-        //   ['address', 'uint24', 'address', 'uint24', 'address'],
-        //   [
-        //     WISER,
-        //     bestRoute.path[0].feeTier,
-        //     bestRoute.intermediaryToken.address,
-        //     bestRoute.path[1].feeTier,
-        //     ESD
-        //   ]
-        // );
-
-        // const params = {
-        //   path,
-        //   recipient: YOUR_ADDRESS,
-        //   deadline: Math.floor(Date.now() / 1000) + 60 * 20, // 20 minutes
-        //   amountIn: ethers.parseEther('1.0'),
-        //   amountOutMinimum: ethers.parseUnits(quote.amountOut, 6) * 995n / 1000n // 0.5% slippage
-        // };
-
-        // const tx = await router.exactInput(params);
-        //         `);
+        console.log(
+          "\nTo execute this multi-hop swap, see multihop-wiser-esd.js in examples folder."
+        );
       }
     } else {
       throw new Error("No routes found for WISER -> ESD");

Diff for: examples/get-quote-single-swap.js

@@ -1,7 +1,7 @@
 // Example of using the SailFish DEX v3 SDK
 
 const { ethers } = require("ethers");
-const { Quoter, Router, TradeType } = require("../dist");
+const { Quoter, Router, TradeType } = require("../dist/index.cjs");
 
 async function main() {
   try {

Diff for: examples/multihop-wiser-esd.js

@@ -1,7 +1,7 @@
 // Example of a multi-hop swap between WISER and ESD using WEDU as intermediary token
 
 const { ethers } = require("ethers");
-const { Quoter, Router, TradeType } = require("../dist");
+const { Quoter, Router, TradeType } = require("../dist/index.cjs");
 
 // This example requires a private key to sign transactions
 // Replace with your own private key and NEVER share it or commit it to version control

Diff for: examples/nextjs-example/.next/cache/webpack/client-development-fallback/0.pack.gz

@@ -0,0 +1,5 @@
+NEXT_PUBLIC_PROJECT_ID = WALLET_CONNECT_PROJECT_ID
+NEXT_PUBLIC_EXPLORER = https://opencampus-codex.blockscout.com
+NEXT_PUBLIC_CHAIN_ID = 656476
+NEXT_PUBLIC_RPC_URL = https://rpc.open-campus-codex.gelato.digital
+NEXT_PUBLIC_BLOCK_SCOUT = https://opencampus-codex.blockscout.com

Diff for: examples/nextjs-example/.next/cache/webpack/client-development-fallback/1.pack.gz

@@ -0,0 +1,41 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

Diff for: examples/nextjs-example/.next/cache/webpack/client-development-fallback/index.pack.gz

@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

Diff for: examples/nextjs-example/.next/cache/webpack/client-development-fallback/index.pack.gz.old

@@ -0,0 +1,21 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript"),
+  {
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off", // Disables the rule
+    },
+  },
+];
+
+export default eslintConfig;

Diff for: examples/nextjs-example/.next/cache/webpack/client-development/0.pack.gz

@@ -0,0 +1,13 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  /* config options here */
+  reactStrictMode: false,
+  webpack: (config) => {
+    config.resolve.fallback = { fs: false, net: false, tls: false };
+    config.externals.push("pino-pretty", "lokijs", "encoding");
+    return config;
+  },
+};
+
+export default nextConfig;