|
1 | | -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
| 1 | +# Web3Camp MultiSender - React Implementation |
| 2 | + |
| 3 | +This is a React implementation of the Web3Camp MultiSender application, which allows sending ETH and ERC-20 tokens to multiple addresses in a single transaction. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Send ETH and ERC-20 tokens to multiple addresses in a single transaction |
| 8 | +- Import addresses and amounts from Excel files |
| 9 | +- Support for multiple networks (Ethereum, BSC, Polygon) |
| 10 | +- Transaction history tracking |
| 11 | +- Modern, responsive UI |
2 | 12 |
|
3 | 13 | ## Getting Started |
4 | 14 |
|
5 | | -First, run the development server: |
| 15 | +### Prerequisites |
6 | 16 |
|
| 17 | +- Node.js (v14 or later) |
| 18 | +- npm or yarn |
| 19 | +- MetaMask or compatible Web3 wallet |
| 20 | + |
| 21 | +### Installation |
| 22 | + |
| 23 | +1. Clone the repository: |
7 | 24 | ```bash |
8 | | -npm run dev |
| 25 | +git clone https://github.com/Web3Camp-Labs/multisender.git |
| 26 | +cd multisender/react-app |
| 27 | +``` |
| 28 | + |
| 29 | +2. Install dependencies: |
| 30 | +```bash |
| 31 | +npm install |
| 32 | +# or |
| 33 | +yarn install |
| 34 | +``` |
| 35 | + |
| 36 | +3. Start the development server: |
| 37 | +```bash |
| 38 | +npm start |
9 | 39 | # or |
10 | | -yarn dev |
| 40 | +npm run dev |
11 | 41 | ``` |
12 | 42 |
|
13 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 43 | +4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. |
| 44 | + |
| 45 | +### Build for Production |
| 46 | + |
| 47 | +```bash |
| 48 | +npm run build |
| 49 | +``` |
| 50 | + |
| 51 | +The build output will be in the `build/` directory. |
| 52 | + |
| 53 | +## Usage |
| 54 | + |
| 55 | +1. **Connect Wallet**: Click the "Connect Wallet" button in the header to connect your Web3 wallet. |
| 56 | + |
| 57 | +2. **Step 1 - Prepare**: |
| 58 | + - Enter the token address (use 0x000000000000000000000000000000000000bEEF for ETH) |
| 59 | + - Import addresses and amounts from Excel or enter them manually in the format: `address,amount` |
| 60 | + - Click "Next" to proceed |
14 | 61 |
|
15 | | -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. |
| 62 | +3. **Step 2 - Confirm**: |
| 63 | + - Review the list of recipients and transaction summary |
| 64 | + - For ERC-20 tokens, approve the token spending if needed |
| 65 | + - Click "Send" to execute the transactions |
16 | 66 |
|
17 | | -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. |
| 67 | +4. **Step 3 - Result**: |
| 68 | + - View the transaction history with links to block explorers |
| 69 | + - Download a CSV file of any failed transactions (if applicable) |
18 | 70 |
|
19 | | -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. |
| 71 | +## Network Support |
20 | 72 |
|
21 | | -## Learn More |
| 73 | +The application supports the following networks: |
| 74 | +- Ethereum Mainnet |
| 75 | +- Binance Smart Chain |
| 76 | +- Polygon |
| 77 | +- BSC Testnet |
22 | 78 |
|
23 | | -To learn more about Next.js, take a look at the following resources: |
| 79 | +## Technical Details |
24 | 80 |
|
25 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
26 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 81 | +This application is built with: |
| 82 | +- React 18 |
| 83 | +- TypeScript |
| 84 | +- Vite (fast build tool) |
| 85 | +- ethers.js for Web3 integration |
| 86 | +- React Bootstrap for UI components |
| 87 | +- Styled Components for styling |
27 | 88 |
|
28 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
| 89 | +## License |
29 | 90 |
|
30 | | -## Deploy on Vercel |
| 91 | +This project is licensed under the MIT License - see the LICENSE file for details. |
31 | 92 |
|
32 | | -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. |
| 93 | +## Acknowledgments |
33 | 94 |
|
34 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
| 95 | +- Original Next.js implementation by Web3Camp |
| 96 | +- [ethers.js](https://docs.ethers.io/) |
| 97 | +- [React Bootstrap](https://react-bootstrap.github.io/) |
0 commit comments