bnb-chain · tawhidnazari57 · Jun 11, 2024 · Jun 11, 2024 · Jun 11, 2024 · Jun 13, 2024
diff --git a/.github/workflows/jekyll-docker.yml b/.github/workflows/jekyll-docker.yml
@@ -0,0 +1,20 @@
+name: Jekyll site CI
+
+on:
+ push:
+ branches: [ "main" ]
+ pull_request:
+ branches: [ "main" ]
+
+jobs:
+ build:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Build the site in the jekyll/builder container
+ run: |
+ docker run \
+ -v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \
+ jekyll/builder:latest /bin/bash -c "chmod -R 777 /srv/jekyll && jekyll build --future"
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,7 @@ site/
 .cache
 
 .DS_Store
+
+build
+
+.docusaurus
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Welcome to BNBChain Knowledge Base
+# Welcome to BNB Chain Knowledge Base
 
-This is the BNBChain Knowledge Base documentation for the BNBChain developers. It is based on the Mkdocs Material theme. 
+This is the BNB Chain Knowledge Base documentation for the BNB Chain developers. It is based on the Mkdocs Material theme. 
 
 ## Prerequisite 
 
@@ -24,5 +24,5 @@ This is the BNBChain Knowledge Base documentation for the BNBChain developers. I
 
 ## 📜 License
 
-Copyright (c) 2024 BNBChain 
+Copyright (c) 2024 BNB Chain 
 
diff --git a/docs/announce/altai-gnfd.md b/docs/announce/altai-gnfd.md
@@ -0,0 +1,30 @@
+# Altai Upgrade of Greenfield
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+
+## Upgrade Timeline
+
+- Testnet: Sep 21th 2024 06:00:00 AM UTC Blockheight: 12,513,708
+
+- Mainnet: Sep 23th 2024 06:00:00 AM UTC Blockheight: 11,917,971
+
+
+For Validators: greenfield [v1.9.1](https://github.com/bnb-chain/greenfield/releases/tag/v1.9.1?ref=bnbchain.ghost.io)
+
+For SP: no action needed.
+
+
+## Hot Fix Release
+Greenfield and the Metamask extension are facing compatibility issues, affecting some functionalities such as bucket creation on Dcellar.
+This issue is occurring because the MetaMask Extension recently upgraded its middleware library to the latest version, 
+implementing stricter EIP712 signature verification rules.
+
+This release contains the hotfix to resolve this issue, all dapps that using the go-sdk and js-sdk is suggested to upgrade to the 
+latest version.
+
+- [Go-SDK v1.7.3](https://github.com/bnb-chain/greenfield-go-sdk/releases/tag/v1.7.3)
+- [Js-SDK v2.2.0-alpha](https://github.com/bnb-chain/greenfield-js-sdk/releases/tag/%40bnb-chain%2Fgreenfield-js-sdk%402.2.0-alpha.0)
+
diff --git a/docs/announce/bohr-bsc.md b/docs/announce/bohr-bsc.md
@@ -0,0 +1,27 @@
+# Bohr Upgrade of BSC
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+## Upgrade Timeline
+The Bohr upgrade will happen at:
+
+- Testnet: 2024-08-20 01:23:16 AM UTC(passed)
+- Mainnet: 2024-09-26 02:20:00 AM UTC
+
+## Upgrade BSC Mainnet Nodes to v1.4.14 Before Hardfork
+Release [v1.4.14](https://github.com/bnb-chain/bsc/releases/tag/v1.4.14) is a hard fork release for BSC Mainnet, the HF name is: [Bohr](https://forum.bnbchain.org/t/bnb-chain-roadmap-mainnet/936)
+
+There are 4 BEPs in Bohr:
+
+- BEP-341: Validators can produce consecutive blocks
+- BEP-402: Complete missing fields in Block Header to generate Signature
+- BEP-404: Clear Miner History when Switching Validators Set
+- BEP-410: Add Agent for Validators
+
+## Key Highlight: [BEP-341: Validators can produce consecutive blocks](https://github.com/bnb-chain/BEPs/blob/master/BEPs/BEP-341.md)
+Among these BEPs, BEP-341 holds the most significance as it proposes a change to the block production protocol. However, BEP-341 will only come into effect after the affirmative outcome of a governance vote.
+
+## Key Highlight: [BEP-402: Complete missing fields in Block Header to generate Signature](https://github.com/bnb-chain/BEPs/blob/master/BEPs/BEP-402.md)
+BEP-402 updates the block header signature logic, please pay special attention if your product involves the logic of block header verification.
diff --git a/docs/announce/feynman-bsc.md b/docs/announce/feynman-bsc.md
@@ -2,14 +2,13 @@
 
 <div class="doc-announce-info">
  <span class="version-tag">Hardfork</span>
- <span class="announce-date">2024 April 10</span>
 </div>
 
 ## Upgrade Timeline
 The Haber upgrade will happen at:
 
-- Testnet: 11th March 2024 at 6:00 UTC
-- Mainnet: 18th April 2024 at 05:49 UTC
+- Testnet: March 11 2024 06:00:00 AM UTC
+- Mainnet: April 18 2024 05:49:00 AM UTC
 
 ## Upgrade to BSC Node v1.3.13 Before Hardfork
 

diff --git a/docs/announce/final-sunset-bc-testnet.md b/docs/announce/final-sunset-bc-testnet.md
@@ -0,0 +1,44 @@
+# Final Sunset Hardfork of BC Testnet
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+## Upgrade Timeline
+
+The Final Sunset Hardfork will happen at:
+
+- Testnet: August 1 2024 6:00:00 AM UTC
+
+## Upgrade to BC Node v0.10.23 Before Hardfork
+
+BC node need to be upgraded before the hardfork time.
+
+- https://github.com/bnb-chain/node/releases/tag/v0.10.23
+
+### Upgrade Instructions
+
+As a fullnode runner, you need to take the following steps before the hardfork block height.
+
+1) Download the new v0.10.23 binary and replace the previous version.
+
+2) Download the new config
+ file [app.toml](https://github.com/bnb-chain/node/releases/download/v0.10.23/testnet_config.zip) to replace the
+ previous version or add the following under the [upgrade] module of `app.toml`.
+
+```toml
+FinalSunsetHeight = 56218686
+```
+
+3) Stop the bnbchaind process and restart it with v0.10.23.
+
+```shell
+service bnbchaind restart
+```
+
+## Key Highlight
+
+After Final Sunset, the cross-chain communication between the Beacon Chain and BSC will be completely stopped.
+The validators in the Beacon Chain community will gradually shut down, and the entire chain will no longer accept 
+new transactions or propose new blocks.
+For more information about BNB Chain Fusion, please refer to [this](https://www.bnbchain.org/en/bnb-chain-fusion).
diff --git a/docs/announce/fjord-opbnb.md b/docs/announce/fjord-opbnb.md
@@ -0,0 +1,54 @@
+# Fjord Upgrade of opBNB
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+
+## Upgrade Timeline
+
+The Fjord upgrade will happen at:
+
+- Testnet: Sep-10-2024 06:00 AM +UTC
+- Mainnet: Sep-24-2024 06:00 AM +UTC
+
+## Upgrade opBNB op-node and op-geth to v0.5.0 Before Hardfork
+
+Releases:
+
+- https://github.com/bnb-chain/opbnb/releases/tag/v0.5.0
+- https://github.com/bnb-chain/op-geth/releases/tag/v0.5.0
+
+Docker Images
+
+- ghcr.io/bnb-chain/op-node:v0.5.0
+- ghcr.io/bnb-chain/op-geth:v0.5.0
+- ghcr.io/bnb-chain/op-batcher:v0.5.0
+- ghcr.io/bnb-chain/op-proposer:v0.5.0
+
+## Key Highlight: L1 fee calculation changed
+
+Fjord updates the L1 cost calculation function to use a FastLZ-based compression estimator. The L1 cost is computed as:
+
+```
+l1FeeScaled = l1BaseFeeScalar*l1BaseFee*16 + l1BlobFeeScalar*l1BlobBaseFee
+estimatedSizeScaled = max(minTransactionSize * 1e6, intercept + fastlzCoef*fastlzSize)
+l1Fee = estimatedSizeScaled * l1FeeScaled / 1e12
+```
+
+You can find the detailed explanation in the [spec](https://specs.optimism.io/protocol/fjord/exec-engine.html).
+
+## User Facing Changes
+
+* New flag `--wait-node-sync` added to op-batcher (default false), indicates if during startup, the batcher should wait for a recent batcher tx on L1 to finalize (via more block confirmations). This should help avoid duplicate batcher txs
+* New flag `--wait-node-sync` added to op-proposer (default false), indicates if during startup, the proposer should wait for the rollup node to sync to the current L1 tip before proceeding with its driver loop
+* New flag `--compression-algo` added to op-batcher (default zlib), user can choose brotli algo after Fjord fork
+* New flag `--l1.rpc-max-cache-size` added to op-node (default 1000), so user can config the the maximum cache size of the L1 client
+
+## Pull Requests
+
+* Merge upstream v1.7.7 by @bnoieh in https://github.com/bnb-chain/opbnb/pull/216
+* feat(op-node): Keep consistent status when meet an unexpected el sync by @krish-nr in https://github.com/bnb-chain/opbnb/pull/222
+* feat(op-node): add l1 cache size config by @welkin22 in https://github.com/bnb-chain/opbnb/pull/225
+* feat(op-chain-ops): add Wright fork config into genesis file generation code by @welkin22 in https://github.com/bnb-chain/opbnb/pull/226
+
diff --git a/docs/announce/haber-bsc.md b/docs/announce/haber-bsc.md
@@ -2,14 +2,13 @@
 
 <div class="doc-announce-info">
  <span class="version-tag">Hardfork</span>
- <span class="announce-date">2024 May 24</span>
 </div>
 
 ## Upgrade Timeline
 The Haber upgrade will happen at:
 
-- Testnet: 2024-05-29 06:07:00 AM UTC
-- Mainnet: 2024-06-20 06:05:00 AM UTC
+- Testnet: May 29 2024 06:07:00 AM UTC
+- Mainnet: June 20 2024 06:05:00 AM UTC
 
 ## Upgrade to BSC Node v1.4.8 Before Hardfork
 Release [v1.4.8](https://github.com/bnb-chain/bsc/releases/tag/v1.4.8) is a cut-in **hard fork release for BSC Testnet and Mainnet**, the HF name is: [Haber](https://forum.bnbchain.org/t/bnb-chain-roadmap-mainnet/936#h-4haber-wip-25), it only supports one BEP: [BEP-381: Precompile for secp256r1 Curve Support](https://github.com/bnb-chain/BEPs/blob/master/BEPs/BEP-381.md)

diff --git a/docs/announce/haber-opbnb.md b/docs/announce/haber-opbnb.md
@@ -2,15 +2,14 @@
 
 <div class="doc-announce-info">
  <span class="version-tag">Hardfork</span>
- <span class="announce-date">2024 May 24</span>
 </div>
 
 
 ## Upgrade Timeline
 The Haber upgrade will happen at:
 
-- Testnet: May 30, 2024, at 6:00 AM UTC
-- Mainnet: June 20th, 2024 08:00:00 AM UTC
+- Testnet: May 30 2024, 06:00:00 AM UTC
+- Mainnet: June 20 2024 08:00:00 AM UTC
 
 ## Upgrade to opBNB Node v0.4.2 Before Hardfork
 

diff --git a/docs/announce/index.md b/docs/announce/index.md
@@ -2,27 +2,18 @@
 # Announcement
 
 <div class="doc-announce">
- <a href="./haber-bsc">
+ <a href="./altai-gnfd/">
   <div>
-  <div class="announce-title">BSC Harber Hardfork</div>
-  <div class="announce-desc">Enable EIP7212 to support precompiled secp256r1 curve on BSC</div>
+  <div class="announce-title">Altai Upgrade of Greenfield </div>
+  <div class="announce-desc">A hotfix release to address Metamask compatibility issue</div>
   </div>
-  <span class="announce-date">2023 MAY 24</span>
+  <span class="announce-date">2024 Sep 23</span>
  </a>
- <a href="./haber-opbnb">
+ <a href="./bohr-bsc/">
   <div>
-  <div class="announce-title">opBNB Harber Hardfork</div>
-  <div class="announce-desc">Enable EIP7212 to support precompiled secp256r1 curve on opBNB</div>
+  <div class="announce-title">Bohr Upgrade of BSC (Mainnet)</div>
+  <div class="announce-desc">Introduce 4 BEPs on BSC Mainnet</div>
   </div>
-  <span class="announce-date">2023 MAY 24</span>
+  <span class="announce-date">2024 Sep 26</span>
  </a>
-  <a href="./serengeti-greenfield">
-  <div>
-  <div class="announce-title">Greenfield Serengeti Hardfork</div>
-  <div class="announce-desc">Introduce major updates and enhancements to the platform, including storage fee paymaster</div>
-  </div>
-  <span class="announce-date">2023 MAY 24</span>
- </a>
-
-
 </div>
diff --git a/docs/announce/mongolian-greenfield.md b/docs/announce/mongolian-greenfield.md
@@ -0,0 +1,31 @@
+# Mongolian Upgrade of Greenfield
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+
+## Upgrade Timeline
+
+- Testnet: July 31th 2024 07:00:00 AM UTC Blockheight: 10,780,238
+
+- Mainnet: August 8th 2024 07:00:00 AM UTC Blockheight: 10,314,605
+
+## Validators and SPs should complete upgrading to the latest version before hardfork: 
+
+For Validators: greenfield [v1.9.0](https://github.com/bnb-chain/greenfield/releases/tag/v1.9.0?ref=bnbchain.ghost.io)
+
+For SPs: greenfield-storage-provider [v1.9.0](https://github.com/bnb-chain/greenfield-storage-provider/releases/tag/v1.9.0?ref=bnbchain.ghost.io)
+
+## New features introduced:
+
+* [#639] https://github.com/bnb-chain/greenfield/pull/639 feat: Support msg to create policy by cross chain
+
+## Bug fixing
+* [#638] https://github.com/bnb-chain/greenfield/pull/638 fix: initial val for min value comparison should be large enough
+* [#640] https://github.com/bnb-chain/greenfield/pull/640 fix: broken links reroute from local repo to bnbchain docs
+
+## Docs
+* [#633] https://github.com/bnb-chain/greenfield/pull/633 docs: replace docs link
+
+[//]: # (Reference: https://www.bnbchain.org/en/blog/bnb-greenfield-mongolian-hardfork)
diff --git a/docs/announce/second-sunset-bc-testnet.md b/docs/announce/second-sunset-bc-testnet.md
@@ -0,0 +1,43 @@
+# Second Sunset Hardfork of BC Testnet
+
+<div class="doc-announce-info">
+ <span class="version-tag">Hardfork</span>
+</div>
+
+## Upgrade Timeline
+
+The Second Sunset Hardfork will happen at:
+
+- Testnet: June 21 2024 6:00:00 AM UTC
+
+## Upgrade to BC Node v0.10.21 Before Hardfork
+
+BC node need to be upgraded before the hardfork time.
+
+- https://github.com/bnb-chain/node/releases/tag/v0.10.21
+
+### Upgrade Instructions
+
+As a fullnode runner, you need to take the following steps before the hardfork block height.
+
+1) Download the new v0.10.21 binary and replace the previous version.
+
+2) Download the new config
+ file [app.toml](https://github.com/bnb-chain/node/releases/download/v0.10.21/testnet_config.zip) to replace the
+ previous version or add the following under the [upgrade] module of `app.toml`.
+
+```toml
+SecondSunsetHeight = 54554742
+```
+
+3) Stop the bnbchaind process and restart it with v0.10.21.
+
+```shell
+service bnbchaind restart
+```
+
+## Key Highlight
+
+All TimeLocks and AtomicSwaps on BC tesnet will automatically be refunded to user accounts.
+All the BSC delegations will be automatically undelegated and refunded to user accounts after the unbonding period.
+For more information about BNB Chain Fusion, please refer to [this](https://www.bnbchain.org/en/bnb-chain-fusion).