Merge pull request #510 from bnb-chain/develop

feat: implement BEP294 and BEP297 (#436)
bnb-chain · Feb 26, 2024 · 9d09d0a · 9d09d0a
2 parents b3a5c1f + 2386310
commit 9d09d0a
Show file tree

Hide file tree

Showing 135 changed files with 26,303 additions and 10,329 deletions.
diff --git a/.env.example b/.env.example
@@ -1,2 +1,4 @@
+RPC_BSC=https://bsc-dataseed1.ninicoin.io
+
 UNLOCK_RECEIVER=
 OPERATOR_PRIVATE_KEY=
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+### Description
+
+add a description of your changes here...
+
+### Rationale
+
+tell us why we need these changes...
+
+### Example
+
+add an example CLI or API response...
+
+### Changes
+
+Notable changes:
+* add each change in a bullet point here
+* ...
diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml
@@ -0,0 +1,30 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            feat
+            fix
+            docs
+            style
+            refactor
+            perf
+            test
+            build
+            ci
+            chore
+            revert
+            release
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -0,0 +1,59 @@
+name: Unit Test
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - bc-fusion
+  pull_request:
+    branches:
+      - master
+      - develop
+      - bc-fusion
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v1
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+          forge install --no-git --no-commit foundry-rs/[email protected]
+
+      - name: Lint Check
+        run: |
+          npm run lint:check
+
+      - name: Build
+        run: |
+          forge build
+
+      - name: Start Local Chain
+        run: |
+          npm install pm2 -g
+          pm2 start --name local-chain "anvil -f https://bsc-dataseed1.ninicoin.io"
+          sleep 5
+        env:
+          PORT: 8545
+
+      - name: Unit Test
+        run: |
+          forge test --rpc-url http://127.0.0.1:8545
diff --git a/.gitignore b/.gitignore
@@ -5,10 +5,12 @@ out/
 pids/
 logs/
 cache/
+broadcast/
 
 contracts/flattened/*.sol
 
 # foundry lib
 lib/forge-std/
 
 .env
+**/.bak
diff --git a/README.md b/README.md
@@ -13,13 +13,14 @@ Install foundry:
 ```shell script
 curl -L https://foundry.paradigm.xyz | bash
 foundryup
-forge install --no-git --no-commit foundry-rs/forge-std@v1.1.1
+forge install --no-git --no-commit foundry-rs/forge-std@v1.7.3
 ```
 
-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
@@ -46,7 +47,7 @@ forge test
 ## Flatten all system contracts
 
 ```shell script
-bash flatten.sh
+bash scripts/flatten.sh
 ```
 
 All system contracts will be flattened and output into `${workspace}/contracts/flattened/`.
@@ -55,18 +56,18 @@ All system contracts will be flattened and output into `${workspace}/contracts/f
 
 1. Edit `init_holders.js` file to alloc the initial BNB holder.
 2. Edit `validators.js` file to alloc the initial validator set.
-3. Run `bash scripts/generate-*.sh` to change system contracts setting.
+3. Edit system contracts setting as needed.
 4. Run `node scripts/generate-genesis.js` will generate genesis.json
 
-## How to generate mainnet/testnet/QA genesis file
+## How to generate mainnet/testnet/dev genesis file
 
 ```shell 
-bash scripts/generate.sh mainnet
-bash scripts/generate.sh testnet
-bash scripts/generate.sh QA
-bash scripts/generate.sh local
+poetry run python -m scripts.generate ${network}
 ```
 Check the `genesis.json` file, and you can get the exact compiled bytecode for different network.
+(`poetry run python -m scripts.generate --help ` for more details)
+
+You can refer to `generate:dev` in `package.json` for more details about how to custom params for local dev-net.
 
 ## How to update contract interface for test
 

diff --git a/abi/README.md b/abi/README.md
@@ -1,7 +1,7 @@
 # ABI Files for Build-In System Contracts
 
 | Contract Name         | Address                                    | ABI file name                                      |
-|-----------------------|--------------------------------------------|----------------------------------------------------|
+| --------------------- | ------------------------------------------ | -------------------------------------------------- |
 | BSCValidatorSet       | 0x0000000000000000000000000000000000001000 | [bscvalidatorset](bscvalidatorset.abi)             |
 | SlashIndicator        | 0x0000000000000000000000000000000000001001 | [slashindicator](slashindicator.abi)               |
 | SystemReward          | 0x0000000000000000000000000000000000001002 | [systemreward](systemreward.abi)                   |
@@ -12,4 +12,10 @@
 | GovHub                | 0x0000000000000000000000000000000000001007 | [govhub](govhub.abi)                               |
 | TokenManager          | 0x0000000000000000000000000000000000001008 | [tokenmanager](tokenmanager.abi)                   |
 | CrossChain            | 0x0000000000000000000000000000000000002000 | [crosschain](crosschain.abi)                       |
-| Staking               | 0x0000000000000000000000000000000000002001 | [staking](staking.abi)                             |
+| Staking               | 0x0000000000000000000000000000000000002001 | [staking](staking.abi)                             |
+| StakeHub              | 0x0000000000000000000000000000000000002002 | [stakehub](staking.abi)                            |
+| StakeCredit           | 0x0000000000000000000000000000000000002003 | [stakecredit](stakecredit.abi)                     |
+| BSCGovernor           | 0x0000000000000000000000000000000000002004 | [bscgovernor](bscgovernor.abi)                     |
+| GovToken              | 0x0000000000000000000000000000000000002005 | [govtoken](govtoken.abi)                           |
+| BSCTimelock           | 0x0000000000000000000000000000000000002006 | [bsctimelock](bsctimelock.abi)                     |
+| TokenRecoverPortal    | 0x0000000000000000000000000000000000003000 | [tokenrecoverportal](tokenrecoverportal.abi)                     |