punkkit-sdk 1.0.0

package/.env

@@ -0,0 +1,47 @@
+# RPC 和 钱包配置。使用hardhat本地测试时候需要注释掉,会使用hardhat默认rpc以及账户
+RPC_URL= "http://127.0.0.1:8666"
+PRIVATE_KEY="0x6c19b85fa2d365e74b4b36556e1369fb9d680789e6e9350f9b62412efe3a76cc"
+ACCOUNT_ADDR="0x9748b3f8B628f11abD2474085DD44F8ffD8EB3e6"
+
+
+# 地址配置
+Coinbase="0xAa9e62EB6d74d66Ff6720D1A8143c8237067Ff58"
+ChainYVaultV2="0xAa9e62EB6d74d66Ff6720D1A8143c8237067Ff58"
+ChainXAuctionV2="0x88566F811b751Fa527A0816d99d6968E00f2eBef"
+IUnlockStrategy=""
+
+Create2= "0x5FbDB2315678afecb367f032d93F642f64180aa3"
+Token0= "0x3E8d9Ad590542AE8731960202CE0334B5c7c317D"
+Token1= "0xF8407E61094a14601a7224AB628152B309788659"
+PoolManager= "0xDB0412DaB8210ccA6d9875eE0be7b580A3c12046"
+LiquidPool= "0x931D3dd4922c67C2C727c2Cf20313c5e541cB7A3"
+LimitOrder= "0x2267dCcfebEa4C2A54A14F7ffa997a089Eb99040"
+DynamicFee= "0x53660445Cda97cAD89c88cA67C099418412AD040"
+
+MutiVoucher="0000000000000000000000000000000000000044"
+# ABI配置
+IUnlockStrategy_abi_path='artifacts/contracts/auction/interfaces/IUnlockStrategy.sol/IUnlockStrategy.json'
+ChainYVault_abi_path='artifacts/contracts/auction/ChainYVaultV2.sol/ChainYVaultV2.json'
+ChainXAuction_abi_path='artifacts/contracts/auction/ChainXAuctionV2.sol/ChainXAuctionV2.json'
+Coinbase_abi_path='artifacts/contracts/auction/coinbase-and-stake/coinbase.sol/Coinbase.json'
+
+PoolManager_abi_path='artifacts/@uniswap/v4-core/src/PoolManager.sol/PoolManager.json'
+MockERC20_abi_path='artifacts/contracts/uniswap/MockERC20.sol/MockERC20.json'
+LiquidPool_abi_path='artifacts/contracts/uniswap/LiquidPool.sol/LiquidPool.json'
+LimitOrder_abi_path='artifacts/contracts/uniswap/LimitOrder.sol/LimitOrder.json'
+DynamicFee_abi_path='artifacts/contracts/uniswap/DynamicFee.sol/DynamicFee.json'
+Create2_abi_path='artifacts/contracts/uniswap/Create2.sol/Create2.json'
+Example_abi_path='artifacts/contracts/uniswap/Example.sol/Example.json'
+
+MutiVoucher_abi_path='artifacts/contracts/MutiVoucher.sol/MutiVoucher.json'
+
+# uniswap 全局配置
+# SALT 用于 Create2 部署
+SALT="0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470"
+SALT_LIMITORDER="0xb10e2d527612073b26eecdfd717e6a320cf44b4afac2b0732d9fcbe2b7fa0cf6"
+# 价格配置 (1 token0 = PRICE_INIT token1)
+PRICE_INIT=1
+PRICE_LIMIT=1.1
+# 初始流动性和供应量 (单位: ETH)
+INITIAL_LIQUIDITY=1000
+INITIAL_SUPPLY=210000000

package/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "contracts/auction/coinbase-and-stake"]
+	path = contracts/auction/coinbase-and-stake
+	url = git@github.com:LazyDreamingDog/coinbase-and-stake.git

package/README.md

@@ -0,0 +1,158 @@
+# Uniswap V4 Hook Deployment & Use cases
+
+## 1. Run Uniswap V4 built-in tests
+
+In [Uniswap V4 core](https://github.com/Uniswap/v4-core) repo:
+
+```bash
+npx hardhat test
+```
+
+## 2. Compile pool and hook contracts
+
+In [Our Uniswap v4 periphery](https://github.com/tofudfy/v4-periphery) repo:
+
+```bash
+npx hardhat compile
+```
+
+Move the required ABI files from `artifacts/contracts` to [SDK repo](https://github.com/tofudfy/v4-sdk) `scripts/frontend/abi`.
+
+## 3. Deploy pool and hook contracts
+
+In [Our Uniswap V4 SDK](https://github.com/tofudfy/v4-sdk) repo:
+
+1. Start a local blockchain node
+
+   ```bash
+   npx hardhat node
+   ```
+
+2. Deploy [Uniswap V4 core](https://github.com/Uniswap/v4-core) contracts
+
+3. Configure blockchain networks, wallet, and contract addresses in:  
+   `scripts/config.ts`
+
+4. Run the hook deployment script:
+
+   ```bash
+   npx hardhat run scripts/depoly/depoly.ts
+   ```
+
+   - Limit Order Hook: `contracts/LimitOrder.sol`  
+   - Dynamic Fee Hook: `contracts/DynamicFee.sol`
+
+## 4. Initialize the PoolManager contract
+
+Run the initialization script:
+
+```bash
+npx hardhat run scripts/frontend/init/init.ts
+```
+
+## 5. Contract interactions
+
+### 5.1 Trading at Market Price 
+
+- Add liquidity:
+
+  ```bash
+  npx hardhat run scripts/frontend/marketprice/addLiquidity.ts
+  ```
+
+- Swap:
+
+  ```bash
+  npx hardhat run scripts/frontend/marketprice/swap.ts
+  ```
+
+- Remove liquidity:
+
+  ```bash
+  npx hardhat run scripts/frontend/marketprice/removeLiquidity.ts
+  ```
+
+### 5.2 Trading of Limit Order
+
+(*Requires `addLiquidity` operation first, otherwise order placement will fail*)  
+
+- Place order:
+
+  ```bash
+  npx hardhat run scripts/frontend/limitorder/place.ts
+  ```
+
+- [Todo] Cancel order:
+
+  ```bash
+  npx hardhat run scripts/frontend/limitorder/kill.ts
+  ```
+
+- [Todo] Withdraw liquidity:
+
+  ```bash
+  npx hardhat run scripts/frontend/limitorder/withdraw.ts
+  ```
+
+### 5.3 Dynamic fee
+
+- Adjust fee:
+
+  ```bash
+  npx hardhat test scripts/feehook/testfeehook.ts
+  ```
+
+## UniswapV4及hook部署使用
+
+1. 运行uniswapv4自带测试：
+命令行输入`npx hardhat test`
+2. 合约编译：`npx hardhat compile`
+将必要的abi文件从`artifacts/contracts`移至`scripts/frontend/abi`
+3. 部署uniswapv4合约以及hook合约：
+    1. 运行本地区块链节点网络：`npx hardhat node`
+    2. 配置文件,配置区块链网络、钱包以及合约地址：`scripts/frontend/lib/address.ts`
+    3. hook合约部署脚本：`npx hardhat run scripts/frontend/depoly/depoly.ts`
+        + 限价交易hook:`contracts/LimitOrder.sol`
+        + 动态手续费hook:`contracts/DynamicFee.sol`
+
+4. 初始化poolmanager合约：
+运行初始化脚本：`npx hardhat run scripts/frontend/init/init.ts`
+
+5. 合约调用：
+    1. 市价交易：
+        + 添加流动性：`npx hardhat run scripts/frontend/marketprice/addLiquidity.ts`
+        + 交易：`npx hardhat run scripts/frontend/marketprice/swap.ts`
+        + 撤销流动性：`npx hardhat run scripts/frontend/marketprice/removeLiquidity.ts`
+    2. 限价交易：(接`添加流动性`操作，否则无法正常`挂单`)
+        + 挂单：`npx hardhat run scripts/frontend/limitorder/place.ts`
+        + [失败]撤单：`npx hardhat run scripts/frontend/limitorder/kill.ts`
+        + [失败]提取流动性：`npx hardhat run scripts/frontend/limitorder/withdraw.ts`
+    3. 动态手续费：
+        + [存疑]调整手续费：`npx hardhat test scripts/feehook/testfeehook.ts`
+## 待完成事项
+
++ 类似挖矿的流动性激励hook合约
+
+# lq documents
+
+## 部署
+|   依赖   |  版本      |
+|   ----   | ----       |
+|    nvm   |  0.39.7    |
+|   npm    | v20.19.5  |
+
+运行命令：
+```shell
+npm install
+
+npx hardhat node # 单独使用命令行执行
+
+npx hardhat run scripts/deploy/deploy.ts
+npx hardhat run scripts/deploy/inits.ts
+```
+## 测试
+voucher测试通过
+
+```shell
+ npx hardhat test test/voucher.ts
+```

package/config/auction.config.ts

@@ -0,0 +1,40 @@
+import {
+  RPC_URL,
+  PRIVATE_KEY,
+  config,
+} from "./env.config";
+import {join} from "path";
+
+const chainXAuctionV2Addr=config.contracts.auction.chainXAuctionV2;
+const chainYVaultV2Addr=config.contracts.auction.chainYVaultV2;
+const coinbaseAddr=config.contracts.auction.coinbase;
+
+const AUCTION_ADDR={
+  chainXAuction:chainXAuctionV2Addr,
+  chainYVault:chainYVaultV2Addr,
+  coinbase:coinbaseAddr,
+}
+
+// ABI路径
+const ABI_PATHS = config.abiPaths.auction;
+function relativePath(filepath:string):string{
+  const ROOT = '..';
+  return join(ROOT,filepath)
+}
+
+const AUCTION_ABI = {
+  coinbase: require(relativePath(ABI_PATHS.coinbase)),
+  chainXAuction: require(relativePath(ABI_PATHS.chainXAuction)),
+  chainYVault: require(relativePath(ABI_PATHS.chainYVault)),
+} as const;
+
+export { RPC_URL, PRIVATE_KEY };
+export { AUCTION_ADDR,AUCTION_ABI};
+
+if (require.main === module) {
+    console.log("=== Auction 配置验证 ===\n");
+    console.log("合约地址:");
+    console.log("ChainYVaultV2:", chainYVaultV2Addr);
+    console.log("ChainXAuctionV2:", chainXAuctionV2Addr);   
+    console.log("Coinbase:", coinbaseAddr); 
+}

package/config/env.config.ts

@@ -0,0 +1,204 @@
+import * as dotenv from "dotenv";
+import { ethers } from "ethers";
+import * as path from "path";
+
+// 加载环境变量
+dotenv.config({ path: path.resolve(__dirname, "../.env") });
+
+/**
+ * 环境变量配置接口定义
+ */
+export interface EnvConfig {
+    // RPC 和钱包配置
+    rpc: {
+        url: string;
+    };
+    wallet: {
+        privateKey: string;
+        address: string;
+    };
+
+    // 合约地址配置
+    contracts: {
+        mutiVoucher:string;
+        auction: {
+            chainYVaultV2: string;
+            chainXAuctionV2: string;
+            coinbase: string;
+        };
+        uniswap: {
+            create2: string;
+            token0: string;
+            token1: string;
+            poolManager: string;
+            liquidPool: string;
+            limitOrder: string;
+            dynamicFee: string;
+        };
+    };
+    // ABI 文件路径配置 (完整路径)
+    abiPaths: {
+        mutiVoucher:string;
+        auction: {
+            chainYVault: string;
+            chainXAuction: string;
+            coinbase:string;
+        };
+        uniswap: {
+            poolManager: string;
+            mockERC20: string;
+            liquidPool: string;
+            limitOrder: string;
+            dynamicFee: string;
+            create2: string;
+            example: string;
+        };
+    };
+    // Pool 配置
+    pool: {
+        salt: string;
+        saltLimitOrder: string;
+        priceInit: number;
+        priceLimit: number;
+        initialLiquidity: bigint;
+        initialSupply: bigint;
+        dynamicFeeFlag: number;
+    };
+    // 路径配置
+    paths: {
+        abiRootDir: string;  // ABI 文件根目录
+    };
+}
+
+/**
+ * 从环境变量中获取值,如果不存在则使用默认值
+ */
+function getEnvValue(key: string, defaultValue: string): string {
+    const value = process.env[key];
+    if (value === undefined || value === "") {
+        return defaultValue;
+    }
+    return value;
+}
+
+/**
+ * 从环境变量中获取数字值
+ */
+function getEnvNumber(key: string, defaultValue: number): number {
+    const value = process.env[key];
+    if (value === undefined || value === "") {
+        return defaultValue;
+    }
+    const parsed = parseFloat(value);
+    if (isNaN(parsed)) {
+        console.warn(`Warning: ${key} is not a valid number, using default value ${defaultValue}`);
+        return defaultValue;
+    }
+    return parsed;
+}
+
+/**
+ * 从环境变量中获取 BigInt 值
+ */
+function getEnvBigInt(key: string, defaultValue: string): bigint {
+    const value = getEnvValue(key, defaultValue);
+    try {
+        return ethers.utils.parseEther(value).toBigInt();
+    } catch (error) {
+        console.warn(`Warning: ${key} is not a valid ether value, using default value ${defaultValue}`);
+        return ethers.utils.parseEther(defaultValue).toBigInt();
+    }
+}
+
+/**
+ * 拼接 ABI 文件路径
+ * @param rootDir ABI 根目录
+ * @param relativePath 相对路径
+ * @returns 完整路径
+ */
+function joinAbiPath(rootDir: string, relativePath: string): string {
+    // 移除路径中的多余斜杠
+    const cleanRoot = rootDir.replace(/\/+$/, "");
+    const cleanRelative = relativePath.replace(/^\/+/, "");
+    return `${cleanRoot}/${cleanRelative}`;
+}
+
+/**
+ * 加载并解析环境变量配置
+ */
+function loadConfig(): EnvConfig {
+    // 获取 ABI 根目录
+    const abiRootDir = getEnvValue("ABI_ROOT_DIR", "chain-core/ABI");
+
+    return {
+        rpc: {
+            url: getEnvValue("RPC_URL", "http://127.0.0.1:8545/"),
+        },
+        wallet: {
+            privateKey: getEnvValue(
+                "PRIVATE_KEY",
+                "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
+            ),
+            address: getEnvValue(
+                "ACCOUNT_ADDR",
+                "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+            ),
+        },
+        contracts: {
+            mutiVoucher:getEnvValue("MutiVoucher",""),
+            auction: {
+                chainYVaultV2: getEnvValue("ChainYVaultV2", ""),
+                chainXAuctionV2: getEnvValue("ChainXAuctionV2", ""),
+                coinbase: getEnvValue("Coinbase", ""),
+            },
+            uniswap: {
+                create2: getEnvValue("Create2", "0x5FbDB2315678afecb367f032d93F642f64180aa3"),
+                token0: getEnvValue("Token0", "0x3e7B83B8bb8eE2D4d74ec805aeb1465e65E15E24"),
+                token1: getEnvValue("Token1", "0xF4DB8B5cC187B286Eb54Bf76c6b041286a46E4Ee"),
+                poolManager: getEnvValue("PoolManager", "0xDB0412DaB8210ccA6d9875eE0be7b580A3c12046"),
+                liquidPool: getEnvValue("LiquidPool", "0xBFd16A06062060FA08EFca22e3b6d334EcF3E2f0"),
+                limitOrder: getEnvValue("LimitOrder", "0x7982Cd1B4162c145e6c1a0f7fD3De4676950D040"),
+                dynamicFee: getEnvValue("DynamicFee", "0x541eEcD8E9A59476E436A766123B27330e149040"),
+            },
+        },
+        abiPaths: {
+            mutiVoucher: getEnvValue("MutiVoucher_abi_path", "MutiVoucher.json"),
+            auction: {
+                chainYVault: getEnvValue("ChainYVault_abi_path", "ChainYVaultV2.json"),
+                chainXAuction: getEnvValue("ChainXAuction_abi_path", "ChainXAuctionV2.json"),
+                coinbase: getEnvValue("Coinbase_abi_path", "Coinbase.json"),
+            },
+            uniswap: {
+                poolManager: getEnvValue("PoolManager_abi_path", "PoolManager.json"),
+                mockERC20: getEnvValue("MockERC20_abi_path", "MockERC20.json"),
+                liquidPool: getEnvValue("LiquidPool_abi_path", "LiquidPool.json"),
+                limitOrder: getEnvValue("LimitOrder_abi_path", "LimitOrder.json"),
+                dynamicFee: getEnvValue("DynamicFee_abi_path", "DynamicFee.json"),
+                create2: getEnvValue("Create2_abi_path", "Create2.json"),
+                example: getEnvValue("Example_abi_path", "Example.json"),
+            },
+        },
+        pool: {
+            salt: getEnvValue("SALT", ethers.utils.keccak256("0x00")),
+            saltLimitOrder: getEnvValue("SALT_LIMITORDER", ethers.utils.keccak256("0x01")),
+            priceInit: getEnvNumber("PRICE_INIT", 1),
+            priceLimit: getEnvNumber("PRICE_LIMIT", 1.1),
+            initialLiquidity: getEnvBigInt("INITIAL_LIQUIDITY", "1000"),
+            initialSupply: getEnvBigInt("INITIAL_SUPPLY", "210000000"),
+            dynamicFeeFlag: 0x800000,
+        },
+        paths: {
+            abiRootDir,
+        },
+        
+    };
+}
+
+/**
+ * 导出配置对象
+ */
+export const config: EnvConfig = loadConfig();
+export const RPC_URL = config.rpc.url;
+export const PRIVATE_KEY = config.wallet.privateKey;
+export const ACCOUNT_ADDR = config.wallet.address;
+

package/config/uniswap.config.ts

@@ -0,0 +1,107 @@
+// 从集中的配置解析器导入所有配置
+import {
+  config,
+  RPC_URL,
+  PRIVATE_KEY,
+} from "./env.config";
+import {join} from "path";
+
+
+
+// ============================== 导出配置供其他模块使用 ======================================
+export { RPC_URL, PRIVATE_KEY };
+export { CONTRACT_ADDRESSES,CONTRACTS_ABI,POOL_KEYS};
+export { SALT, SALT_LIMITORDER, PRICE_INIT, PRICE_LIMIT, INITIAL_LIQUIDITY, INITIAL_SUPPLY };
+
+
+
+// ============================== Contract Address ============================================
+const CONTRACT_ADDRESSES = {
+    Create2: config.contracts.uniswap.create2,
+    Token0: config.contracts.uniswap.token0,
+    Token1: config.contracts.uniswap.token1,
+    PoolManager: config.contracts.uniswap.poolManager,
+    LiquidPool: config.contracts.uniswap.liquidPool,
+    LimitOrder: config.contracts.uniswap.limitOrder,
+    DynamicFee: config.contracts.uniswap.dynamicFee,
+};
+
+// ============================== Contract ABIs ============================================
+function relativePath(filepath:string):string{
+  const ROOT = '..';
+  return join(ROOT,filepath)
+}
+// Uniswap ABI 路径
+const ABI_PATHS = config.abiPaths.uniswap;
+
+const CONTRACTS_ABI={
+  PoolManager: require(relativePath(ABI_PATHS.poolManager)),
+  MockERC20: require(relativePath(ABI_PATHS.mockERC20)),
+  LiquidPool: require(relativePath(ABI_PATHS.liquidPool)),
+  LimitOrder: require(relativePath(ABI_PATHS.limitOrder)),
+  DynamicFee: require(relativePath(ABI_PATHS.dynamicFee)),
+  Create2: require(relativePath(ABI_PATHS.create2)),
+  Example: require(relativePath(ABI_PATHS.example)),
+}
+
+// ============================== Pool Keys ================================================
+// Pool 配置
+const SALT = config.pool.salt;
+const SALT_LIMITORDER = config.pool.saltLimitOrder;
+const PRICE_INIT = config.pool.priceInit;
+const PRICE_LIMIT = config.pool.priceLimit;
+const INITIAL_LIQUIDITY = config.pool.initialLiquidity;
+const INITIAL_SUPPLY = config.pool.initialSupply;
+const DYNAMIC_FEE_FLAG = config.pool.dynamicFeeFlag;
+
+
+const POOL_KEYS = {
+  limitOrderPoolKey: {
+    currency0: CONTRACT_ADDRESSES.Token0,
+    currency1: CONTRACT_ADDRESSES.Token1,
+    fee: 60,
+    tickSpacing: 60,
+    hooks: CONTRACT_ADDRESSES.LimitOrder,
+  },
+  dynamicFeePoolKey: {
+    currency0: CONTRACT_ADDRESSES.Token0,
+    currency1: CONTRACT_ADDRESSES.Token1,
+    fee: DYNAMIC_FEE_FLAG,
+    tickSpacing: 60,
+    hooks: CONTRACT_ADDRESSES.DynamicFee,
+  },
+};
+
+
+if (require.main === module) {
+  console.log("=== Uniswap 配置验证 ===\n");
+
+  console.log("ABI 路径:");
+  console.log("- PoolManager:", ABI_PATHS.poolManager);
+  console.log("- MockERC20:", ABI_PATHS.mockERC20);
+  console.log("- LiquidPool:", ABI_PATHS.liquidPool);
+  console.log("- LimitOrder:", ABI_PATHS.limitOrder);
+  console.log("- DynamicFee:", ABI_PATHS.dynamicFee);
+  console.log("- Create2:", ABI_PATHS.create2);
+  console.log("- Example:", ABI_PATHS.example);
+
+  console.log("\n合约地址:");
+  console.log("- Token0:", CONTRACT_ADDRESSES.Token0);
+  console.log("- Token1:", CONTRACT_ADDRESSES.Token1);
+  console.log("- PoolManager:", CONTRACT_ADDRESSES.PoolManager);
+  console.log("- LiquidPool:", CONTRACT_ADDRESSES.LiquidPool);
+  console.log("- LimitOrder:", CONTRACT_ADDRESSES.LimitOrder);
+  console.log("- DynamicFee:", CONTRACT_ADDRESSES.DynamicFee);
+  console.log("- Create2:", CONTRACT_ADDRESSES.Create2);
+
+  console.log("\nPool 配置:");
+  console.log("- SALT:", SALT.toString());
+  console.log("- SALT_LIMITORDER:", SALT_LIMITORDER.toString());
+  console.log("- PRICE_INIT:", PRICE_INIT);
+  console.log("- PRICE_LIMIT:", PRICE_LIMIT);
+  console.log("- INITIAL_LIQUIDITY:", INITIAL_LIQUIDITY.toString());
+  console.log("- INITIAL_SUPPLY:", INITIAL_SUPPLY.toString());
+  console.log("- DYNAMIC_FEE_FLAG:", DYNAMIC_FEE_FLAG.toString(16));
+
+  console.log("poolKeys:", POOL_KEYS);
+}

package/config/voucher.config.ts

@@ -0,0 +1,10 @@
+import { config } from "./env.config";
+import { join } from "path";
+// MutiVoucher 相关
+function relativePath(filepath:string):string{
+    const ROOT = '..';
+    return join(ROOT,filepath)
+}
+
+export const MUTI_VOUCHER_ADDR=config.contracts.mutiVoucher
+export const MUTI_VOUCHER_ABI = require(relativePath(config.abiPaths.mutiVoucher));

package/contracts/MutiVoucher.sol

@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.15;
+
+// import "./utils/ownable.sol";
+
+contract MutiVoucher {
+    struct Voucher {
+        uint256 conversionRate; // exchange rate with ETH
+        mapping(address => uint256) balances;
+    }
+    bytes32[] private voucherNames;
+    mapping(bytes32 => Voucher) private vouchers;
+
+    event VoucherCreated(bytes32 voucherName, uint256 conversionRate);
+    event VoucherPurchased(address buyer, bytes32 voucherName, uint256 amount);
+    event VoucherUsed(address user, bytes32 voucherName, uint256 amount);
+
+    // Create new voucher and store in vouchers
+    function createVoucher(
+        bytes32 name,
+        uint256 conversionRate
+    ) external {
+        require(
+            conversionRate > 0,
+            "Conversion rate must be greater than zero"
+        );
+        require(vouchers[name].conversionRate == 0, "Voucher already exist");
+
+        // Create new voucher
+        Voucher storage newVoucher = vouchers[name];
+        newVoucher.conversionRate = conversionRate;
+        voucherNames.push(name);
+
+        emit VoucherCreated(name, conversionRate);
+    }
+
+    function getVoucherInfo(
+        bytes32 name
+    ) external view returns (uint256 conversionRate) {
+        require(vouchers[name].conversionRate > 0, "Voucher doesn't exist");
+        return vouchers[name].conversionRate;
+    }
+
+    function buy(bytes32 name) external payable {
+        require(vouchers[name].conversionRate > 0, "Voucher doesn't exist");
+        require(msg.value > 0, "Message value must be greater than zero");
+        // Attention the unit of value is wei
+        uint256 expectedAmount = msg.value * vouchers[name].conversionRate;
+        vouchers[name].balances[msg.sender] += expectedAmount;
+        emit VoucherPurchased(msg.sender, name, expectedAmount);
+    }
+
+    function use(bytes32 name, uint256 amount) external {
+        require(vouchers[name].conversionRate > 0, "Voucher doesn't exist");
+        require(amount > 0, "Amount must be greater than zero");
+        require(
+            vouchers[name].balances[msg.sender] >= amount,
+            "Insufficient balance"
+        );
+
+        // Reduce balance
+        vouchers[name].balances[msg.sender] -= amount;
+        emit VoucherUsed(msg.sender, name, amount);
+    }
+
+    // Query balance of an address in voucher
+    function balanceOf(
+        bytes32 name,
+        address user
+    ) external view returns (uint256) {
+        require(vouchers[name].conversionRate > 0, "Voucher doesn't exist");
+        return vouchers[name].balances[user];
+    }
+
+    function getAllVouchers() external view returns (bytes32[] memory) {
+        return voucherNames;
+    }
+}