Welcome to Aboki Finance — a decentralized P2P crypto swap and liquidity platform.
This documentation is crafted for everyone: users, developers, and contributors.

1. Overview
2. For Users
3. For Developers
4. Smart Contract API
5. Security
6. Deployment & Environment
7. Order Lifecycle & Error Handling
8. Contributing
9. FAQ
10. License & Acknowledgements

Aboki Finance is a trustless dApp for swapping crypto and providing liquidity, featuring:

• Modern frontend: React, Vite, TypeScript, Tailwind CSS.
• Web3 Integration: Wagmi, Viem, Privy, Ethers.js.
• EVM Contracts: Secure, audited, and upgradable.
• User-focused: Simple, secure, and open-source.

• Swap crypto: Instantly exchange supported tokens.
• Provide liquidity: Earn rewards by supplying to pools.
• Track activity: See your swap and liquidity history.
• Stay secure: Your wallet, your keys.

1. Access the App

   • Visit the live site or run locally (see Developer section).

2. Connect Your Wallet

   • Click “Connect Wallet”.
   • Use MetaMask, WalletConnect, or Privy.

3. Swap Tokens

   • Go to "Swap".
   • Select input/output tokens and amount.
   • Click "Swap" and confirm in your wallet.

4. Add Liquidity

   • Go to "Add Liquidity".
   • Select tokens and amounts.
   • Approve and confirm via your wallet.

5. Track Activity

   • Visit "Activity" or "Liquidity Dashboard" to see your history.

6. Disconnect

   • Disconnect your wallet for extra safety after use.

• Frontend: React, Vite, TypeScript, Tailwind CSS
• Web3: Wagmi, Viem, Ethers.js, Privy
• Contracts: Solidity, OpenZeppelin, Uniswap V2
• Testing/Deploy: Hardhat, Node.js

src/
├── App.tsx           # Main routes
├── main.tsx          # App root, providers
├── assets/           # Images, logos
├── components/       # UI (Navbar, Modals, Swap, Liquidity, etc)
├── context/          # React Contexts (liquidity, swap)
├── contracts/        # ABIs, contract hooks
├── hooks/            # Custom hooks
├── pages/            # Route-level pages (Landing, Swap, Activity, etc)

1. Clone the Repo

   git clone https://github.com/Aboki-finance/FrontEnd.git
   cd FrontEnd

2. Install Dependencies

   npm install
   # or
   yarn install

3. Set Up Environment Variables

   • Copy .env.example to .env and fill in the required fields (see Deployment & Environment).

4. Run the Dev Server

   npm run dev
   # or
   yarn dev

   • Visit http://localhost:5173 in your browser.

5. Lint, Format, and Test

   npm run lint
   npm run format
   npm run test

Main Functions

• createOrderWithSwap(address[] path, uint256 amountIn, uint256 minOut)
• estimateSwapOutput(address[] path, uint256 amountIn)
• setTokenSupport(address token, bool ok) (Admin only)
• setProtocolFeePercent(uint256 feeBp) (Admin only)

Events

• OrderCreated(orderId, user, amountIn, minOut)
• SwapExecuted(orderId, amountOut)

Example (wagmi)

import { useContractWrite } from 'wagmi';
const { write } = useContractWrite({
  address: GATEWAY_ADDRESS,
  abi: SimpleGatewayABI,
  functionName: 'createOrderWithSwap',
});
write({ args: [path, amountIn, minOut] });

• ReentrancyGuard: Prevents reentrancy attacks.
• Ownable: Restricts admin functions.
• Token Whitelist: Only approved tokens can be swapped.
• Slippage Protection: Users set minOut.
• Audited: SecureChain Labs, 2024.

Set required ENV vars (.env):

Build for Production:

npm run build
# or
yarn build

Deploy:
Upload dist/ folder to your static host (Vercel, Netlify, etc).

Deploy with Hardhat:

npx hardhat deploy --network mainnet --tags SimpleGateway

Order Status

• PENDING: Swap submitted, waiting for execution.
• EXECUTED: Swap successful.
• FAILED: Swap failed (slippage, gas, etc).
• CANCELLED: User cancelled (frontend only).

Common Errors

1. Fork & Clone the repo.
2. Create a Feature Branch:

   git checkout -b feat/your-feature

3. Code, Lint, Test:

   npm run lint && npm run test

4. Open a Pull Request on main with a clear description.

Q: What wallets are supported?
A: All EVM wallets (MetaMask, WalletConnect, Privy, etc).

Q: Can I use the frontend without deployed contracts?
A: You can view the UI, but swaps/liquidity require your wallet and live contracts.

Q: Is my data private?
A: Yes. You control your keys and sign all transactions yourself.

Q: Where do I get help or report bugs?
A: Open an issue at Aboki-finance/FrontEnd Issues.

• MIT License (see LICENSE)
• Built with: React, Vite, Tailwind, Wagmi, Viem, Privy, Ethers.js, Uniswap, OpenZeppelin
• Audited by SecureChain Labs (2024)

For more, see the source code, contract ABIs, or contact the maintainers at Aboki-finance/FrontEnd.