chore: auto validate read-only calls (vechain#161)

* chore: auto validate read-only calls * feat: auto add name, decimals and symbol * fix: validate provided info * revert readme * Update README.md * Update script.js * Update contract.js --------- Co-authored-by: libotony <[email protected]>
vechain-energy · Apr 4, 2024 · d1174ee · d1174ee
1 parent b6a9721
commit d1174ee
Show file tree

Hide file tree

Showing 18 changed files with 305 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -5,8 +5,8 @@ Token-registry is a platform where you can submit the token. Token-registry will
 ## Requirements 
 1. Make sure the contract address is correct (main/test)
 2. Token image is required
-3. Folder name must be the same as the contract address 
-4. Clear and simple description 
+3. Folder name must be the same as the contract address in lowercase
+4. Clear and simple description
 5. Comply with directory & contents rules
 
 ## Getting Ready for Submission

diff --git a/abis.js b/abis.js
@@ -0,0 +1,178 @@
+const totalSupply = {
+  constant: true,
+  inputs: [],
+  name: "totalSupply",
+  outputs: [
+    {
+      name: "",
+      type: "uint256",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const balanceOf = {
+  constant: true,
+  inputs: [
+    {
+      name: "_owner",
+      type: "address",
+    },
+  ],
+  name: "balanceOf",
+  outputs: [
+    {
+      name: "balance",
+      type: "uint256",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const allowance = {
+  constant: true,
+  inputs: [
+    {
+      name: "_owner",
+      type: "address",
+    },
+    {
+      name: "_spender",
+      type: "address",
+    },
+  ],
+  name: "allowance",
+  outputs: [
+    {
+      name: "remaining",
+      type: "uint256",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const decimals = {
+  constant: true,
+  inputs: [],
+  name: "decimals",
+  outputs: [
+    {
+      name: "",
+      type: "uint8",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const name = {
+  constant: true,
+  inputs: [],
+  name: "name",
+  outputs: [
+    {
+      name: "",
+      type: "string",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const symbol = {
+  constant: true,
+  inputs: [],
+  name: "symbol",
+  outputs: [
+    {
+      name: "",
+      type: "string",
+    },
+  ],
+  payable: false,
+  stateMutability: "view",
+  type: "function",
+};
+
+const transfer = {
+  constant: false,
+  inputs: [
+    {
+      name: "_to",
+      type: "address",
+    },
+    {
+      name: "_value",
+      type: "uint256",
+    },
+  ],
+  name: "transfer",
+  outputs: [],
+  payable: false,
+  stateMutability: "nonpayable",
+  type: "function",
+};
+
+const transferFrom = {
+  constant: false,
+  inputs: [
+    {
+      name: "_from",
+      type: "address",
+    },
+    {
+      name: "_to",
+      type: "address",
+    },
+    {
+      name: "_value",
+      type: "uint256",
+    },
+  ],
+  name: "transferFrom",
+  outputs: [],
+  payable: false,
+  stateMutability: "nonpayable",
+  type: "function",
+};
+
+const approve = {
+  constant: false,
+  inputs: [
+    {
+      name: "_spender",
+      type: "address",
+    },
+    {
+      name: "_value",
+      type: "uint256",
+    },
+  ],
+  name: "approve",
+  outputs: [],
+  payable: false,
+  stateMutability: "nonpayable",
+  type: "function",
+};
+
+const abis = {
+  totalSupply,
+  balanceOf,
+  allowance,
+  decimals,
+  name,
+  symbol,
+  transfer,
+  transferFrom,
+  approve,
+};
+
+module.exports = abis;
diff --git a/contract.js b/contract.js
@@ -0,0 +1,86 @@
+const abis = require("./abis");
+const { abi, address } = require("thor-devkit");
+const axios = require("axios");
+
+const totalSupplyAbi = new abi.Function(abis.totalSupply);
+const balanceOfAbi = new abi.Function(abis.balanceOf);
+const allowanceAbi = new abi.Function(abis.allowance);
+const decimalsAbi = new abi.Function(abis.decimals);
+const nameAbi = new abi.Function(abis.name);
+const symbolAbi = new abi.Function(abis.symbol);
+
+const verifyCalls = [
+  balanceOfAbi.encode("0xf077b491b355E64048cE21E3A6Fc4751eEeA77fa"),
+  allowanceAbi.encode(
+    "0xf077b491b355E64048cE21E3A6Fc4751eEeA77fa",
+    "0x435933c8064b4Ae76bE665428e0307eF2cCFBD68",
+  ),
+];
+const verifyContract = async (address, url) => {
+  try {
+    const clauses = verifyCalls.map((data) => ({
+      to: address,
+      data,
+      value: "0x0",
+    }));
+
+    const resp = await axios.post(`${url}/accounts/*`, {
+      clauses,
+    });
+
+    if (resp.data.some((r) => r.reverted)) {
+      throw new Error("Some contract calls reverted");
+    }
+
+    if (resp.data.length !== verifyCalls.length) {
+      throw new Error("Invalid contract response");
+    }
+  } catch (error) {
+    console.log(error);
+    throw new Error("unable to verify contract methods");
+  }
+};
+
+const contractDetailsClauses = [
+  totalSupplyAbi.encode(),
+  decimalsAbi.encode(),
+  nameAbi.encode(),
+  symbolAbi.encode(),
+];
+
+const getContractDetails = async (address, url) => {
+  const clauses = contractDetailsClauses.map((data) => ({
+    to: address,
+    data,
+    value: "0x0",
+  }));
+
+  const resp = await axios.post(`${url}/accounts/*`, {
+    clauses,
+  });
+
+  if (resp.data.some((r) => r.reverted)) {
+    throw new Error("Some contract calls reverted");
+  }
+
+  if (resp.data.length !== contractDetailsClauses.length) {
+    throw new Error("Invalid contract response");
+  }
+
+  const totalSupply = totalSupplyAbi.decode(resp.data[0].data);
+  const decimals = decimalsAbi.decode(resp.data[1].data);
+  const name = nameAbi.decode(resp.data[2].data);
+  const symbol = symbolAbi.decode(resp.data[3].data);
+
+  return {
+    totalSupply: totalSupply["0"],
+    decimals: parseInt(decimals["0"]),
+    name: name["0"],
+    symbol: symbol["0"],
+  };
+};
+
+module.exports = {
+  verifyContract,
+  getContractDetails,
+};
diff --git a/script.js b/script.js
@@ -9,6 +9,8 @@ const { abi } = require('thor-devkit')
 const { getTokens, redFont, greenFont, yellowFont } = require('./utils')
 
 const { NETS: NET_FOLDERS, NODES } = require('./const')
+const abis = require('./abis')
+const { verifyContract, getContractDetails } = require('./contract')
 
 const DIST = path.join(__dirname, './dist')
 const ASSETS = path.join(DIST, 'assets')
@@ -52,16 +54,34 @@ async function packToken(net) {
 
   file.mkdirSync(ASSETS)
 
-  for (const item of listJson) {
+  for (let i = 0; i < listJson.length; i++) {
+    const item = listJson[i]
+
+    const {
+      name,
+      symbol,
+      decimals,
+      totalSupply
+    } = await getContractDetails(item.address, NODES[net])
+
+    if (name !== item.name) 
+      throw new Error(`name does not match contract name (info=${item.name}, contract=${name})`)
+    if (symbol !== item.symbol) 
+      throw new Error(`symbol does not match contract symbol (info=${item.symbol}, contract=${symbol})`)
+    if (decimals !== item.decimals) 
+      throw new Error(`decimals does not match contract decimals (info=${item.decimals}, contract=${decimals})`)
+
+    await verifyContract(item.address, NODES[net])
+
     file.copyFileSync(item.img, path.join(ASSETS, `${item.imgName}`))
     result.push({
-      name: item.name,
-      symbol: item.symbol,
-      decimals: item.decimals,
+      name,
+      symbol,
+      decimals,
       address: item.address,
       desc: item.desc,
       icon: item.imgName,
-      totalSupply: item.symbol === 'VTHO' ? 'Infinite' : await getTotalSupply(NODES[net], item.address),
+      totalSupply: item.symbol === 'VTHO' ? 'Infinite' : totalSupply,
       ...item.extra
     })
   }
@@ -172,35 +192,6 @@ async function getCreateTimeFromGit(dirPath) {
     })
   })
 }
-const TSabi = {
-  "constant": true,
-  "inputs": [],
-  "name": "totalSupply",
-  "outputs": [
-    {
-      "name": "",
-      "type": "uint256"
-    }
-  ],
-  "payable": false,
-  "stateMutability": "view",
-  "type": "function"
-}
-async function getTotalSupply(url, address) {
-  const resp = await axios.post(`${url}/accounts/*`, {
-    clauses: [
-      {
-        to: address,
-        value: '0',
-        data: '0x18160ddd'
-      }
-    ]
-  })
-  let tsf = new abi.Function(TSabi)
-  const decoded = tsf.decode(resp.data[0]['data'])
-
-  return decoded[0]
-}
 
 module.exports = {
   clean: clear,

diff --git a/tokens/main/0x0ce6661b4ba86a0ea7ca2bd86a0de87b0b860f14/info.json b/tokens/main/0x0ce6661b4ba86a0ea7ca2bd86a0de87b0b860f14/info.json
@@ -1,5 +1,5 @@
 {
-  "name": "OceanEx",
+  "name": "OceanEx Token",
   "symbol": "OCE",
   "decimals": 18,
   "desc": "OceanEx Token (OCE) is OceanEx's platform token"

diff --git a/tokens/main/0x1b8ec6c2a45cca481da6f243df0d7a5744afc1f8/info.json b/tokens/main/0x1b8ec6c2a45cca481da6f243df0d7a5744afc1f8/info.json
@@ -1,5 +1,5 @@
 {
-  "name": "Decent.bet",
+  "name": "Decent.bet Token",
   "symbol": "DBET",
   "decimals": 18,
   "desc": "DECENT.bet is an open-source p2p gaming platform built on the VeChain blockchain"

diff --git a/tokens/main/0x34109fc2a649965eecd953d31802c67dcc183d57/info.json b/tokens/main/0x34109fc2a649965eecd953d31802c67dcc183d57/info.json
@@ -1,5 +1,5 @@
 {
-    "name": "UNION token",
+    "name": "UNION",
     "symbol": "UNION",
     "decimals":18,
     "desc": "Utility token for NoNerdsInc"

diff --git a/tokens/main/0x46209d5e5a49c1d403f4ee3a0a88c3a27e29e58d/info.json b/tokens/main/0x46209d5e5a49c1d403f4ee3a0a88c3a27e29e58d/info.json
@@ -1,5 +1,5 @@
 {
-    "name": "Jur",
+    "name": "JUR",
     "symbol": "JUR",
     "decimals": 18,
     "desc": "JUR Token is the token of justice. Access a decentralized legal ecosystem for professionals and enterprises."

diff --git a/tokens/main/0x5db3c8a942333f6468176a870db36eef120a34dc/info.json b/tokens/main/0x5db3c8a942333f6468176a870db36eef120a34dc/info.json
@@ -1,5 +1,5 @@
 {
-    "name": "Safe Haven",
+    "name": "Safe Haven Token",
     "symbol": "SHA",
     "decimals": 18,
     "desc": "Asset Management & Inheritance Solutions"