chore: fix bugs and add annotation for error msgs

.gitignore

@@ -13,3 +13,4 @@ contracts/flattened/*.sol
 lib/forge-std/
 
 .env
+**/.bak

README.md

@@ -16,9 +16,11 @@ foundryup
 forge install --no-git --no-commit foundry-rs/[email protected]
 ```
 
-Please make sure your dependency version is as follows:
-
-Node: v12.18.3 
+Install poetry:
+```shell script
+curl -sSL https://install.python-poetry.org | python3 -
+poetry install
+```
 
 Tips: You can manage multi version of Node:
 ```Shell
@@ -59,20 +61,11 @@ All system contracts will be flattened and output into `${workspace}/contracts/f
 
 ## How to generate mainnet/testnet/QA/local genesis file
 
-You may need install some python dependencies firstly.
-Save the following content to `requirements.txt` file, and run `pip install -r requirements.txt` to install them.
-```txt
-Jinja2==3.1.2
-typer==0.9.0
-```
-
-
-Then:
 ```shell 
-python scripts/generate.py ${network}
+poetry run python -m scripts.generate ${network}
 ```
 Check the `genesis.json` file, and you can get the exact compiled bytecode for different network.
-(`python scripts/generate.py --help` for more details)
+(`poetry run python -m scripts.generate --help ` for more details)
 
 ## How to update contract interface for test
 

abi/bscgovernor.abi

@@ -508,6 +508,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "governorProtector",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "hasVoted",
@@ -711,6 +724,26 @@
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "pause",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "paused",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "proposalDeadline",
@@ -1097,6 +1130,13 @@
     "outputs": [],
     "stateMutability": "payable"
   },
+  {
+    "type": "function",
+    "name": "resume",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setLateQuorumVoteExtension",
@@ -1372,6 +1412,12 @@
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "Paused",
+    "inputs": [],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "ProposalCanceled",
@@ -1535,6 +1581,12 @@
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "Resumed",
+    "inputs": [],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "TimelockChange",
@@ -1677,6 +1729,11 @@
     "name": "Empty",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "GovernorPaused",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "InvalidValue",
@@ -1703,6 +1760,11 @@
     "name": "OnlyCoinbase",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "OnlyGovernorProtector",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "OnlySystemContract",

abi/stakecredit.abi

@@ -94,6 +94,25 @@
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "claimableUnbondRequest",
+    "inputs": [
+      {
+        "name": "delegator",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "decimals",
@@ -270,6 +289,11 @@
         "name": "delegator",
         "type": "address",
         "internalType": "address"
+      },
+      {
+        "name": "number",
+        "type": "uint256",
+        "internalType": "uint256"
       }
     ],
     "outputs": [
@@ -294,6 +318,44 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "pendingUnbondRequest",
+    "inputs": [
+      {
+        "name": "delegator",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "rewardRecord",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "slash",
@@ -339,6 +401,25 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "totalPooledBNBRecord",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "totalSupply",
@@ -466,11 +547,6 @@
             "internalType": "uint256"
           }
         ]
-      },
-      {
-        "name": "",
-        "type": "uint256",
-        "internalType": "uint256"
       }
     ],
     "stateMutability": "view"
@@ -699,6 +775,11 @@
     "name": "OutOfBounds",
     "inputs": []
   },
+  {
+    "type": "error",
+    "name": "RequestExisted",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "TransferFailed",

abi/stakehub.abi

@@ -558,6 +558,54 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "getValidatorRewardRecord",
+    "inputs": [
+      {
+        "name": "operatorAddress",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "dayIndex",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "getValidatorTotalPooledBNBRecord",
+    "inputs": [
+      {
+        "name": "operatorAddress",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "dayIndex",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "initialize",

abi/systemreward.abi

@@ -146,6 +146,19 @@
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "MAX_REWARDS_FOR_FINALITY",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "RELAYERHUB_CONTRACT_ADDR",
@@ -365,6 +378,30 @@
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "claimRewardsforFinality",
+    "inputs": [
+      {
+        "name": "to",
+        "type": "address",
+        "internalType": "address payable"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "isOperator",