Local Environment Setup

This guide walks through setting up a local development environment for VinuSwap.

Prerequisites

• Node.js 16.x or higher

• npm or yarn

• Git

Clone the Repository

git clone https://github.com/VinuChain/VinuSwap-VinuChain.git
cd VinuSwap-VinuChain

Install Dependencies

npm install

This installs:

• Hardhat development framework

• Solidity compiler

• TypeScript and type generators

• Testing utilities

Compile Contracts

npx hardhat compile

This generates:

• Compiled artifacts in artifacts/

• TypeChain type definitions in typechain-types/

Run Tests

npm run test

Or run specific tests:

npx hardhat test test/core/UniswapV3Factory.spec.ts

Start Local Network

npx hardhat node

This starts a local Hardhat node with:

• 2000 test accounts with 10,000 VC each

• Block time: instant

• Chain ID: 31337

Deploy to Local Network

In a new terminal:

npx hardhat run scripts/deploy.ts --network localhost

Project Structure

VinuSwap-VinuChain/
├── contracts/
│   ├── core/               # Core pool contracts
│   │   ├── VinuSwapFactory.sol
│   │   ├── VinuSwapPool.sol
│   │   └── interfaces/
│   ├── periphery/          # User-facing contracts
│   │   ├── SwapRouter.sol
│   │   ├── NonfungiblePositionManager.sol
│   │   └── ...
│   └── extra/              # Utilities
│       ├── WETH9.sol
│       └── PoolInitHelper.sol
├── scripts/
│   ├── deploy.ts           # Full deployment
│   └── main_scripts/       # Modular scripts
├── sdk/
│   ├── core.ts             # TypeScript SDK
│   └── utils.ts            # Utilities
├── test/
│   ├── core/               # Core contract tests
│   └── periphery/          # Periphery tests
└── hardhat.config.ts       # Hardhat configuration

Hardhat Configuration

The hardhat.config.ts includes:

const config: HardhatUserConfig = {
  solidity: {
    compilers: [
      {
        version: "0.7.6",
        settings: {
          optimizer: {
            enabled: true,
            runs: 200,
          },
        },
      },
    ],
    overrides: {
      // Lower optimization for large contracts
      "contracts/periphery/NonfungiblePositionManager.sol": {
        version: "0.7.6",
        settings: { optimizer: { enabled: true, runs: 1 } },
      },
    },
  },
  networks: {
    hardhat: {
      accounts: { count: 2000 },
    },
    vinu: {
      url: process.env.VINU_RPC_URL || "",
      accounts: process.env.PRIVATE_KEY ? [process.env.PRIVATE_KEY] : [],
    },
  },
};

Environment Variables

Create a .env file:

# VinuChain RPC endpoint
VINU_RPC_URL=https://rpc.vinuchain.org

# Deployer private key (without 0x prefix)
PRIVATE_KEY=your_private_key_here

# Optional: Etherscan API key for verification
ETHERSCAN_API_KEY=your_api_key

TypeScript SDK Setup

The SDK is in the sdk/ directory:

import { VinuSwap } from './sdk/core';

// Create SDK instance
const vinuSwap = await VinuSwap.create(
    tokenA,
    tokenB,
    poolAddress,
    quoterAddress,
    routerAddress,
    positionManagerAddress,
    provider
);

// Connect signer for transactions
const connected = vinuSwap.connect(signer);

Development Workflow

1. Make Contract Changes

Edit contracts in contracts/ directory.

2. Compile

npx hardhat compile

3. Run Affected Tests

npx hardhat test test/path/to/test.spec.ts

4. Run Full Test Suite

npm run test

5. Deploy to Local Network

npx hardhat node
npx hardhat run scripts/deploy.ts --network localhost

Useful Commands

Command	Description
npx hardhat compile	Compile contracts
npm run test	Run all tests
npx hardhat node	Start local node
npx hardhat clean	Clear artifacts
npx hardhat size-contracts	Check contract sizes

Common Issues

Compilation Errors

If you see "Contract code size exceeds limit":

1. Check hardhat.config.ts for optimizer settings

2. Ensure runs is set to 1 for large contracts

3. Consider splitting functionality

Test Timeouts

Increase Mocha timeout in hardhat.config.ts:

mocha: {
    timeout: 100000
}

TypeChain Issues

Regenerate types:

npx hardhat clean
npx hardhat compile

IDE Setup

VS Code

Recommended extensions:

• Solidity (Juan Blanco)

• Hardhat Solidity

• ESLint

• Prettier

Settings (.vscode/settings.json):

{
  "solidity.packageDefaultDependenciesContractsDirectory": "contracts",
  "solidity.packageDefaultDependenciesDirectory": "node_modules",
  "editor.formatOnSave": true
}

Next Steps

• Executing Swaps - Implement token swaps

• Providing Liquidity - Create positions

• Deployment Guide - Deploy to VinuChain