Merge pull request #49 from XinFinOrg/feature-cicd

csc easy deploy with docker

.github/workflows/ci.yml

@@ -42,5 +42,5 @@ jobs:
 
       - name: Build and push image
         run: |
-          docker build . --file docker/Dockerfile --tag ${{ steps.image.outputs.name }}
+          docker build . --file cicd/Dockerfile --tag ${{ steps.image.outputs.name }}
           docker push ${{ steps.image.outputs.name }}

.github/workflows/pr_build.yml

@@ -1,6 +1,6 @@
 name: Build custom branch
 on:
-  pull_request_target:
+  pull_request:
     branches:
       - master
 
@@ -47,5 +47,5 @@ jobs:
 
       - name: Build and push image
         run: |
-          docker build . --file docker/Dockerfile --tag ${{ steps.image.outputs.name }}
+          docker build . --file cicd/Dockerfile --tag ${{ steps.image.outputs.name }}
           docker push ${{ steps.image.outputs.name }}

cicd/.env.example

@@ -0,0 +1,4 @@
+PARENTNET_URL=
+SUBNET_URL=
+PARENTNET_WALLET_PK=0x2222222222222222222222222222222222222222222222222222222222222222
+SUBNET_WALLET_PK=0x1111111111111111111111111111111111111111111111111111111111111111

cicd/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+.env
+package-lock.json
+mount/*
+!mount/placeholder.txt
+yarn.lock
+other

cicd/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:20-alpine
+
+COPY . /app
+
+WORKDIR /app
+RUN yarn
+RUN npx hardhat compile
+WORKDIR /app/cicd
+RUN yarn
+
+ENTRYPOINT ["node"]

cicd/Dockerfile.dockerignore

@@ -0,0 +1,2 @@
+**node_modules
+**package-lock.json

cicd/README.md

@@ -0,0 +1,70 @@
+# XDC CSC CICD
+
+## Deploy XDC CSC
+
+#### Step 1: Create a `.env` File
+
+Based on the provided `.env.example`, create your own `.env` file with the following details:
+
+- **`PARENTNET_URL`**: RPC URL for the parentnet endpoint.
+- **`SUBNET_URL`**: RPC URL for the subnet.
+- **`PARENTNET_WALLET_PK`**: Private key used for CSC deployment, there should be some funds.
+- **`SUBNET_WALLET_PK`**: Private key for subnet deployment. (only required for reverse CSC)
+
+#### Step 2: Deploy CSC
+You have a choice to deploy one of three types of CSC
+
+Full CSC:
+
+```shell
+docker run --env-file .env xinfinorg/csc:latest full.js
+```
+
+Reverse CSC:
+
+```shell
+docker run --env-file .env xinfinorg/csc:latest reversefull.js
+```
+
+Lite CSC:
+
+```shell
+docker run --env-file .env xinfinorg/csc:latest lite.js
+```
+
+
+## Deploy XDC CSC at Custom Block Height
+#### Step 1: Create a `.env` File to cicd/mount
+
+Based on the provided `.env.example`, create your own `.env` file with the following details:
+
+- **`PARENTNET_URL`**: RPC URL for the parentnet endpoint.
+- **`SUBNET_URL`**: RPC URL for the subnet.
+- **`PARENTNET_WALLET_PK`**: Private key used for CSC deployment, there should be some funds.
+- **`SUBNET_WALLET_PK`**: Private key for subnet deployment. (only required for reverse CSC)
+
+#### Step 2: Create a `deployment.config.json` File to cicd/mount
+
+Check the main README in upper directory and deployment.config.json.example to understand the configurations
+
+#### Step 3: Deploy CSC
+
+You have a choice to deploy one of three types of CSC
+
+Full CSC:
+
+```shell
+docker run -v $(pwd)/mount:/app/cicd/mount xinfinorg/csc:latest full.js
+```
+
+Reverse CSC:
+
+```shell
+docker run -v $(pwd)/mount:/app/cicd/mount xinfinorg/csc:latest reversefull.js
+```
+
+Lite CSC:
+
+```shell
+docker run -v $(pwd)/mount:/app/cicd/mount xinfinorg/csc:latest lite.js
+```

cicd/full.js

@@ -0,0 +1,133 @@
+process.chdir(__dirname);
+const { execSync } = require("child_process");
+const fs = require("node:fs");
+const env = require("dotenv").config({ path: "mount/.env" });
+const config = {
+  relativePath: "../",
+};
+const u = require("./util.js");
+
+main();
+
+async function main() {
+  console.log("start deploying full CSC");
+  initDeployFull();
+  await configureFiles();
+  deployFull();
+  exportFull();
+}
+
+function initDeployFull() {
+  const reqENV = ["PARENTNET_URL", "SUBNET_URL", "PARENTNET_WALLET_PK"];
+  const isEnabled = reqENV.every((envVar) => envVar in process.env);
+  if (!isEnabled) {
+    throw Error(
+      "incomplete ENVs, require PARENTNET_URL, SUBNET_URL, PARENTNET_WALLET_PK"
+    );
+  }
+  parentnetPK = process.env.PARENTNET_WALLET_PK.startsWith("0x")
+    ? process.env.PARENTNET_WALLET_PK
+    : `0x${process.env.PARENTNET_WALLET_PK}`;
+  config["parentnetPK"] = parentnetPK;
+  config["parentnetURL"] = process.env.PARENTNET_URL;
+  config["subnetURL"] = process.env.SUBNET_URL;
+}
+
+async function configureFiles() {
+  u.writeEnv(config.parentnetPK, config.relativePath);
+  u.writeNetworkJson(config);
+
+  if (fs.existsSync("./mount/deployment.config.json")) {
+    const dpjs = JSON.parse(
+      fs.readFileSync("./mount/deployment.config.json", "utf8")
+    );
+    console.log(
+      "copying mounted deployment.config.json, start subnet block:",
+      dpjs.subnet.gsbn
+    );
+
+    fs.copyFile(
+      "mount/deployment.config.json",
+      `${config.relativePath}/deployment.config.json`,
+      (err) => {
+        if (err) {
+          throw Error("error writing deployment.config.json, " + err);
+        }
+      }
+    );
+  } else {
+    gap = await u.getGapSubnet(config);
+    writeFullDeployJson(gap);
+  }
+}
+
+function deployFull() {
+  console.log("deploying full csc");
+  fullDeployOut = u.callExec(
+    `
+    cd ${config.relativePath}; 
+    npx hardhat run scripts/FullCheckpointDeploy.js --network xdcparentnet
+    `
+  );
+  fullCSC = parseFullOut(fullDeployOut);
+  config["fullCSC"] = fullCSC;
+}
+
+function exportFull() {
+  console.log(
+    "SUCCESS deploy full csc, please include the following line in your common.env"
+  );
+  console.log(`CHECKPOINT_CONTRACT=${config.fullCSC}\n`);
+  fs.appendFileSync(
+    "mount/csc.env",
+    `\nFULL_CSC=${config.fullCSC}\n`,
+    "utf-8",
+    (err) => {
+      if (err) {
+        throw Error("error writing mount/csc.env, " + err);
+      }
+    }
+  );
+}
+
+function parseFullOut(outString) {
+  strArr = outString.split("\n");
+  lastLine = strArr[strArr.length - 1];
+  if (lastLine == "") {
+    strArr.pop();
+    lastLine = strArr[strArr.length - 1];
+  }
+  if (lastLine.includes("0x")) {
+    idx = lastLine.indexOf("0x");
+    address = lastLine.slice(idx, idx + 42);
+    return address;
+  } else {
+    throw Error("invalid output string: " + outString);
+  }
+}
+
+function writeFullDeployJson(gsbn) {
+  console.log("writing deployment configuration, start subnet block:", gsbn);
+  deployJson = {
+    subnet: {
+      gap: 450,
+      epoch: 900,
+      gsbn: gsbn,
+    },
+  };
+  fs.writeFileSync(
+    `${config.relativePath}/deployment.config.json`,
+    JSON.stringify(deployJson, null, 2),
+    "utf-8",
+    (err) => {
+      if (err) {
+        throw Error("error writing deployment.config.json, " + err);
+      }
+    }
+  );
+  // "subnet": {
+  //   "gap": 450,
+  //   "epoch": 900,
+  //   "gsbn": 1500751
+  // },
+}

cicd/lite.js

@@ -0,0 +1,129 @@
+process.chdir(__dirname);
+const { execSync } = require("child_process");
+const fs = require("node:fs");
+const env = require("dotenv").config({ path: "mount/.env" });
+const config = {
+  relativePath: "../",
+};
+const u = require("./util.js");
+
+main();
+
+async function main() {
+  console.log("start deploying lite CSC");
+  initDeployLite();
+  await configureFiles();
+  deployLite();
+  exportLite();
+}
+
+function initDeployLite() {
+  const reqENV = ["PARENTNET_URL", "SUBNET_URL", "PARENTNET_WALLET_PK"];
+  const isEnabled = reqENV.every((envVar) => envVar in process.env);
+  if (!isEnabled) {
+    throw Error(
+      "incomplete ENVs, require PARENTNET_URL, SUBNET_URL, PARENTNET_WALLET_PK"
+    );
+  }
+  parentnetPK = process.env.PARENTNET_WALLET_PK.startsWith("0x")
+    ? process.env.PARENTNET_WALLET_PK
+    : `0x${process.env.PARENTNET_WALLET_PK}`;
+  config["parentnetPK"] = parentnetPK;
+  config["parentnetURL"] = process.env.PARENTNET_URL;
+  config["subnetURL"] = process.env.SUBNET_URL;
+}
+
+async function configureFiles() {
+  u.writeEnv(config.parentnetPK, config.relativePath);
+  u.writeNetworkJson(config);
+
+  if (fs.existsSync("./mount/deployment.config.json")) {
+    const dpjs = JSON.parse(
+      fs.readFileSync("./mount/deployment.config.json", "utf8")
+    );
+    console.log(
+      "copying mounted deployment.config.json, start subnet block:",
+      dpjs.subnet.gsbn
+    );
+
+    fs.copyFile(
+      "mount/deployment.config.json",
+      `${config.relativePath}/deployment.config.json`,
+      (err) => {
+        if (err) {
+          throw Error("error writing deployment.config.json, " + err);
+        }
+      }
+    );
+  } else {
+    gap = await u.getGapSubnet(config);
+    writeLiteDeployJson(gap);
+  }
+}
+
+function deployLite() {
+  console.log("deploying lite csc");
+  liteDeployOut = u.callExec(
+    `
+    cd ${config.relativePath}; 
+    npx hardhat run scripts/LiteCheckpointDeploy.js --network xdcparentnet
+    `
+  );
+  liteCSC = parseLiteOut(liteDeployOut);
+  config["liteCSC"]=liteCSC
+}
+
+function exportLite() {
+  console.log(
+    "SUCCESS deploy lite csc, please include the following line in your common.env"
+  );
+  console.log(`CHECKPOINT_CONTRACT=${config.liteCSC}\n`);
+  fs.appendFileSync(
+    "mount/csc.env",
+    `\nLITE_CSC=${config.liteCSC}\n`,
+    "utf-8",
+    (err) => {
+      if (err) {
+        throw Error("error writing mount/csc.env, " + err);
+      }
+    }
+  );
+}
+
+
+function parseLiteOut(outString) {
+    strArr = outString.split("\n");
+    lastLine = strArr[strArr.length - 1];
+    if (lastLine == "") {
+      strArr.pop();
+      lastLine = strArr[strArr.length - 1];
+    }
+    if (lastLine.includes("0x")) {
+      idx = lastLine.indexOf("0x");
+      address = lastLine.slice(idx, idx + 42);
+      return address;
+    } else {
+      throw Error("invalid output string: " + outString);
+    }
+}
+
+function writeLiteDeployJson(gsbn) {
+  console.log("writing deployment configuration, start subnet block:", gsbn);
+  deployJson = {
+    subnet: {
+      gap: 450,
+      epoch: 900,
+      gsbn: gsbn,
+    },
+  };
+  fs.writeFileSync(
+    `${config.relativePath}/deployment.config.json`,
+    JSON.stringify(deployJson, null, 2),
+    "utf-8",
+    (err) => {
+      if (err) {
+        throw Error("error writing deployment.config.json, " + err);
+      }
+    }
+  );
+}

cicd/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "csc-cicd",
+  "dependencies": {
+    "dotenv": "^16.3.1",
+    "ethers": "^5.7.2",
+    "axios": "^1.7.2"
+  }
+}