refactor: standardize contract address formatting and add configuration template

Author: YukiTsuchida

pkg/consts/contract.go

@@ -5,8 +5,8 @@ import (
 )
 
 const (
-	IBCHandlerAddress        = "0x727A5648832D2b317925CE043eA9b7fE04B4CD55"
-	CrossSimpleModuleAddress = "0xAA43D337145E8930D01Cb4E60AbF6595C692921E"
+	IBCHandlerAddress = "0x727a5648832d2b317925ce043ea9b7fe04b4cd55"
+	CrossSimpleModuleAddress = "0xaa43d337145e8930d01cb4e60abf6595c692921e"
 )
 
 type contractConfig struct{}

scripts/confgen.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+const fs = require("fs");
+const ejs = require("ejs");
+const path = require("path");
+const util = require("util");
+
+const renderFile = util.promisify(ejs.renderFile);
+
+const {
+  CONF_TPL,
+  IBC_HANDLER,
+  CROSS_SIMPLE_MODULE,
+  CHAIN_ID = "5777",
+  BROADCAST_DIR = "broadcast",
+} = process.env;
+
+if (!CONF_TPL) {
+  console.error("You must set environment variable 'CONF_TPL'");
+  process.exit(1);
+}
+
+function makePairs(arr) {
+  const pairs = [];
+  for (let i = 0; i < arr.length; i += 2) {
+    if (arr[i + 1] === undefined) {
+      console.error("invalid pair found in CONF_TPL");
+      process.exit(1);
+    }
+    pairs.push([arr[i], arr[i + 1]]);
+  }
+  return pairs;
+}
+
+function latestJson(name) {
+  const p = path.join(BROADCAST_DIR, `${name}/${CHAIN_ID}/run-latest.json`);
+  if (!fs.existsSync(p)) {
+    throw new Error(`broadcast not found: ${p}`);
+  }
+  return JSON.parse(fs.readFileSync(p, "utf8"));
+}
+
+function pickAddr(json, contractName) {
+  const txs = json.transactions || [];
+  const hit = txs.filter((t) => t.contractName === contractName && t.contractAddress).pop();
+  return hit && hit.contractAddress;
+}
+
+(async () => {
+  let ibc = IBC_HANDLER;
+  let cross = CROSS_SIMPLE_MODULE;
+
+  if (!ibc || !cross) {
+    const core = latestJson("001_DeployCore.s.sol");
+    const app = latestJson("002_DeployApp.s.sol");
+    ibc = ibc || pickAddr(core, "OwnableIBCHandler");
+    cross = cross || pickAddr(app, "CrossSimpleModule");
+  }
+
+  if (!ibc || !cross) {
+    console.error("failed to resolve contract addresses (ENV or broadcast)");
+    process.exit(1);
+  }
+
+  const targets = makePairs(CONF_TPL.split(":"));
+  for (const [outPath, tplPath] of targets) {
+    const str = await renderFile(tplPath, {
+      IBCHandlerAddress: ibc,
+      CrossSimpleModuleAddress: cross,
+    });
+    fs.writeFileSync(outPath, str);
+    console.log("generated file", outPath);
+  }
+})().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});

scripts/setup.sh

@@ -28,17 +28,23 @@ function chain() {
         echo "variable network must be set"
         exit 1
     fi
+    if [ -z "$CONF_TPL" ]; then
+        echo "variable CONF_TPL must be set"
+        exit 1
+    fi
 
     pushd ./chains && docker compose up -d ${network} && popd
     # XXX Wait for the first block to be created
     sleep 3
     npm run migrate
+    node ./scripts/confgen.js
 }
 
 function development {
     before_common
 
     network=development
+    export CONF_TPL="./pkg/consts/contract.go:./scripts/template/contract.go.tpl"
     chain
 
     after_common

scripts/template/contract.go.tpl

@@ -0,0 +1,22 @@
+package consts
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+)
+
+const (
+	IBCHandlerAddress = "<%= IBCHandlerAddress; %>"
+	CrossSimpleModuleAddress = "<%= CrossSimpleModuleAddress; %>"
+)
+
+type contractConfig struct{}
+
+var Contract contractConfig
+
+func (contractConfig) GetIBCHandlerAddress() common.Address {
+	return common.HexToAddress(IBCHandlerAddress)
+}
+
+func (contractConfig) GetCrossSimpleModuleAddress() common.Address {
+	return common.HexToAddress(CrossSimpleModuleAddress)
+}