Doc for subswap (#25)

Doc for subswap

applications/subswap/README.md

@@ -0,0 +1,6 @@
+# Subswap
+
+Contract Deploy doc in [contract](contract/)
+
+Frontend doc in [contract](https://github.com/XinFinOrg/subswap-frontend)
+

applications/subswap/contract/README.md

@@ -1,32 +1,44 @@
-# Subswap contract
+# Subswap Contract Deployment Guide
 
-## Subswap Deployment Guide
+This guide provides the steps to check and configure necessary values in the `deploy.config.json` file, and then deploy Subswap and the Subnet Token using Hardhat scripts.
 
-### Check `deploy.config.json` File
 
-1. Open the `deploy.config.json` file.
-2. Check the values of `parentnetendpoint` and `subnetendpoint`.
+## Configuration: `deploy.config.json`
+
+1. **Open the `deploy.config.json` File**
+   - Verify the values for `parentnetendpoint` and `subnetendpoint`.
    - `parentnetendpoint`: The endpoint contract address on Parentnet.
    - `subnetendpoint`: The endpoint contract address on Subnet.
+   - `subnettoken`:
+     - `name`: The name of the token.
+     - `symbol`: The symbol of the token.
+     - `initSupply`: The initial supply of the token.
 
-### Deploy Subswap
+## Deploying Subswap
 
-#### Method 1: Using Hardhat Scripts
+### Method 1: Using Hardhat Scripts
 
-1. Install Hardhat and dependencies:
+1. **Install Hardhat and Dependencies**
 
-```
-yarn
-```
+   ```bash
+   yarn
+   ```
 
-2. Deploy the Parentnet Treasury contract:
+2. **Deploy the Parentnet Treasury Contract**
 
-```
-npx hardhat run scripts/parentnettreasurydeploy.js --network xdcparentnet
-```
+   ```bash
+   npx hardhat run scripts/parentnettreasurydeploy.js --network xdcparentnet
+   ```
 
-3. Deploy the Subnet Treasury contract:
+3. **Deploy the Subnet Treasury Contract**
 
+   ```bash
+   npx hardhat run scripts/subnettreasurydeploy.js --network xdcsubnet
+   ```
+
+## Deploying the Subnet Token
+
+```bash
+npx hardhat run scripts/simpletokendeploy.js --network xdcsubnet
 ```
-npx hardhat run scripts/subnettreasurydeploy.js --network xdcsubnet
-```
+

applications/subswap/contract/contracts/SimpleToken.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity =0.8.23;
+
+import {ERC20Burnable, ERC20} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
+
+contract SimpleToken is ERC20Burnable {
+    constructor(
+        string memory name_,
+        string memory symbol_,
+        uint256 initSupply
+    ) ERC20(name_, symbol_) {
+        _mint(msg.sender, initSupply * 1 ether);
+    }
+}

applications/subswap/contract/contracts/TreasuryToken.sol

@@ -8,9 +8,7 @@ contract TreasuryToken is ERC20Burnable, Ownable {
     constructor(
         string memory name_,
         string memory symbol_
-    ) ERC20(name_, symbol_) Ownable(msg.sender) {
-        mint(msg.sender, 10000000e18);
-    }
+    ) ERC20(name_, symbol_) Ownable(msg.sender) {}
 
     function mint(address account, uint256 amount) public onlyOwner {
         _mint(account, amount);

applications/subswap/contract/deploy.config.json

@@ -1,4 +1,5 @@
 {
   "parentnetendpoint": "0x89D933dFBd879DA78643530Bf413c81F94A73c31",
-  "subnetendpoint": "0x0B1795ccA8E4eC4df02346a082df54D437F8D9aF"
+  "subnetendpoint": "0x0B1795ccA8E4eC4df02346a082df54D437F8D9aF",
+  "subnettoken": { "name": "test", "symbol": "test", "initSupply": "1000" }
 }

applications/subswap/contract/scripts/treasurytokendeploy.js → applications/subswap/contract/scripts/simpletokendeploy.js

@@ -5,15 +5,27 @@
 // will compile your contracts, add the Hardhat Runtime Environment's members to the
 // global scope, and execute the script.
 const hre = require("hardhat");
+const deploy = require("../deploy.config.json");
 
 async function main() {
-  const factory = await hre.ethers.getContractFactory("TreasuryToken");
+  const factory = await hre.ethers.getContractFactory("SimpleToken");
 
-  const treasuryToken = await factory.deploy("test", "test");
+  if (!deploy.subnettoken) {
+    console.error("Please set the token config in deploy.config.json");
+    return;
+  }
 
-  await treasuryToken.deployed();
+  const token = deploy.subnettoken;
 
-  console.log("TreasuryToken deploy to ", treasuryToken.address);
+  const simpleToken = await factory.deploy(
+    token.name,
+    token.symbol,
+    token.initSupply
+  );
+
+  await simpleToken.deployed();
+
+  console.log("ERC20 " + token.name + " deploy to ", simpleToken.address);
 }
 
 // We recommend this pattern to be able to use async/await everywhere