diff --git a/docs/BC-FAQs.md b/docs/BC-FAQs.md index d8b2e4e603..be03f76eb8 100644 --- a/docs/BC-FAQs.md +++ b/docs/BC-FAQs.md @@ -4,15 +4,15 @@ sidebar_position: 2 hide_table_of_contents: true --- -# Beacon Chain FAQs +# BNB Beacon Chain FAQs -### What is Beacon Chain and Binance DEX? +### What is BNB Beacon Chain and Binance DEX? -Beacon Chain is the blockchain initially developed by Binance and community. Binance DEX is the decentralized exchange module developed on top of the Beacon Chain blockchain. +BNB Beacon Chain is the blockchain initially developed by Binance and community. Binance DEX is the decentralized exchange module developed on top of the BNB Beacon Chain blockchain. -### What is the design principle of Beacon Chain ? +### What is the design principle of BNB Beacon Chain ? -The main focuses for the design of Beacon Chain are: +The main focuses for the design of BNB Beacon Chain are: - No custody of funds: traders maintain control of their private keys and funds. - High performance: low latency, high throughput for a large user base, and high liquidity trading. @@ -22,7 +22,7 @@ The main focuses for the design of Beacon Chain are: - Fair trading: minimize front-running, to the extent possible. - Evolvable: able to develop with forever-improving technology stack, architecture, and ideas. -### What can you do on Beacon Chain ? +### What can you do on BNB Beacon Chain ? You can: @@ -32,27 +32,27 @@ You can: - Propose to create trading pairs between two different tokens - Send orders to buy or sell assets through trading pairs created on the chain -### Will Beacon Chain introduce more features and transaction types in the future? +### Will BNB Beacon Chain introduce more features and transaction types in the future? -Yes, Beacon Chain team and community would cherish the technology advancements and recommended trends and strive to make circulation of assets and value easier and easier. +Yes, BNB Beacon Chain team and community would cherish the technology advancements and recommended trends and strive to make circulation of assets and value easier and easier. -### What is the native coin on Beacon Chain ? +### What is the native coin on BNB Beacon Chain ? -The Build N Build Coin, BNB, is the native asset on Beacon Chain . There are 200MM BNB coins in total. +The Build N Build Coin, BNB, is the native asset on BNB Beacon Chain . There are 200MM BNB coins in total. There will be no mining. The existing coin burns and freezes will still be in effect on the new -Beacon Chain blockchain. +BNB Beacon Chain blockchain. The exact number of BNB coins will be destroyed based on the same number of BNB ERC20 tokens that have already been destroyed. -Since Beacon Chain is live, all BNB ERC20 tokens will be swapped for Beacon Chain coins. All +Since BNB Beacon Chain is live, all BNB ERC20 tokens will be swapped for BNB Beacon Chain coins. All users who hold BNB ERC20 tokens can deposit them to Binance.com, and upon withdrawal, the new -Beacon Chain native coins will be sent to their new wallets. +BNB Beacon Chain native coins will be sent to their new wallets. -### How can I register on Beacon Chain /DEX and start trading? +### How can I register on BNB Beacon Chain /DEX and start trading? -There is no need to register. All you need is a Beacon Chain address, which can be generated with -any [wallet](https://github.com/bnb-chain/bnb-chain.github.io/blob/master/docs/beaconchain/wallets.md) that supports Beacon Chain . Then you can trade BNB or other assets stored on that address. +There is no need to register. All you need is a BNB Beacon Chain address, which can be generated with +any [wallet](https://github.com/bnb-chain/bnb-chain.github.io/blob/master/docs/beaconchain/wallets.md) that supports BNB Beacon Chain . Then you can trade BNB or other assets stored on that address. ### How can I send orders on Binance DEX? #### Order @@ -66,7 +66,7 @@ In Binance DEX v1.0, the order message contains: - Symbol: trading pair on the chain - Side: buy or sell -- Price: only limit price orders are supported in Beacon Chain v1.0 +- Price: only limit price orders are supported in BNB Beacon Chain v1.0 - Amount - Time In Force: Binance DEX supports `Immediate Or Cancel` (IOC) and `Good Till Expiry` (GTE) orders. GTE orders can quote on the exchange until they are filled by the opposite orders satisfying @@ -110,8 +110,8 @@ will be charged for the network usage, if there is no fill at all for the order #### Where can I see my assets and trades? -You can always use wallets that support Beacon Chain to check your asset balances, open orders, -and (optionally) order/trade history. Beacon Chain Explorer is another tool to check balances +You can always use wallets that support BNB Beacon Chain to check your asset balances, open orders, +and (optionally) order/trade history. BNB Beacon Chain Explorer is another tool to check balances and transactions. #### When can I see my order on the blockchain after I send it? @@ -149,7 +149,7 @@ be used, otherwise, non-BNB fee structure will be used instead. - If the whole order value and free balance for the receiving asset are not enough to pay the fee, all the receiving asset and its residual balance will be charged. -### What is the current Fee Table on Beacon Chain Mainnet? +### What is the current Fee Table on BNB Beacon Chain Mainnet? Fees are variable and may change over time as governance proposals are proposed and voted on. The current fees table for **Mainnet** as of **2021-03-21** is as follows: @@ -195,7 +195,7 @@ Smart Chain Proposal Vote | N/A| 0 BNB | N Cross transfer out relayer reward | N/A| 0.0004 BNB | N -### What is the current Fee Table on Beacon Chain Testnet? +### What is the current Fee Table on BNB Beacon Chain Testnet? Fees are variable and may change over time as governance proposals are proposed and voted on. The current fees table for Testnet as of **2021-03-17** is as follows: @@ -244,7 +244,7 @@ Cross transfer out relayer reward | N/A| 0.0004 BNB | N ### Can I see orders/balances of others or can other people see my orders/balances? Yes, anyone can see anyone's orders and balances if they know the corresponding addresses. -Beacon Chain is 100% transparent for transactions and balances. +BNB Beacon Chain is 100% transparent for transactions and balances. ### Information provided through API and their usage @@ -269,14 +269,14 @@ Tick size is the minimum unit to increase or decrease for the price (in quote as while lot size is the minimum unit to increase or decrease for the quantity (in base asset) of an order.
They are not the same as on Binance.com. They can be queried from API or checked from Wallet UI. -Tick Size and lot size are not fixed. Beacon Chain will automatically/periodically review the values to make +Tick Size and lot size are not fixed. BNB Beacon Chain will automatically/periodically review the values to make sure proper order size and notional is applied. #### Are there limits on notional value of an order? The smallest order you can send for a trading pair is 1 lot size quantity at 1 tick size price. No other limits. -### What is the decimal precision for prices and quantities on Beacon Chain /DEX? +### What is the decimal precision for prices and quantities on BNB Beacon Chain /DEX? Amounts are represented as integers, and all coins have a fixed scale of 8.
This means that if a balance of 100000000 were to be exposed to a wallet integrator, this will represent a balance of 1 coin. @@ -284,17 +284,17 @@ This means that if a balance of 100000000 were to be exposed to a wallet integra ### I forgot the private key for my address, how can I get it back? Sorry, you cannot. Owner of the address takes full responsibility for the private key protection. -Beacon Chain and official wallets do not have your private key. +BNB Beacon Chain and official wallets do not have your private key. ### My private key got stolen by hackers, how can I recover my assets? -Sorry, you take full responsibility of your private key ownership and protection. Beacon Chain +Sorry, you take full responsibility of your private key ownership and protection. BNB Beacon Chain and official wallets will not record, or transfer out your private key. ### What is the Accelerated Node? While users can submit transactions and most of the queries via normal, self-run full nodes.
-Accelerated Node provides more secure and faster lines to access Beacon Chain . +Accelerated Node provides more secure and faster lines to access BNB Beacon Chain . Accelerated Node is special infrastructure built around Validator to facilitate accelerated transaction routing and provide richer, faster user interfaces. There are always several Accelerated Nodes running @@ -304,7 +304,7 @@ For rapid API access, you'd better stay with one Accelerated Node to get better ### How can I issue an asset? -Anyone can pay a fee and issue an asset as Token on Beacon Chain , as long as they provide +Anyone can pay a fee and issue an asset as Token on BNB Beacon Chain , as long as they provide proper information for the fields below, and then execute the command through the command line or http interfaces. - Name: a description string of less than 21 characters @@ -312,41 +312,41 @@ proper information for the fields below, and then execute the command through th - Total Supply: a positive number less than or equal to 90 billions - Mint-able: whether the token can increase Total Supply in later time or not -### What is the consensus algorithm used on Beacon Chain ? +### What is the consensus algorithm used on BNB Beacon Chain ? -Beacon Chain uses BFT and PoS (upcoming) based consensus mechanism to produce blocks among +BNB Beacon Chain uses BFT and PoS (upcoming) based consensus mechanism to produce blocks among a series of qualified Validators. This is similar to the architectures of several existing popular blockchain platforms such as EOS and NEO. -The process for setting up validators among different entities on Beacon Chain is currently being defined. More details will be shared at a later date. +The process for setting up validators among different entities on BNB Beacon Chain is currently being defined. More details will be shared at a later date. -### Can I run a full node for Beacon Chain ? +### Can I run a full node for BNB Beacon Chain ? -Yes, you can. A full node contains all the information and application logic for Beacon Chain . +Yes, you can. A full node contains all the information and application logic for BNB Beacon Chain . It can receive and broadcast blocks and transactions with other full nodes and even validators. The only exception is it will not participate in the consensus if the full node is not a Validator. -### Does Beacon Chain support Smart Contracts? +### Does BNB Beacon Chain support Smart Contracts? No. This was an intentional design decision to improve the performance of the system and eliminate having to support unnecessary features. If you have certain must-have features, it might be added as a native implementation instead of using smart contract.
Feel free to talk to [BNB Chain Community](https://www.buildnbuild.dev/). -### How can I transfer tokens, such as Bitcoin, from other block chains onto Beacon Chain ? +### How can I transfer tokens, such as Bitcoin, from other block chains onto BNB Beacon Chain ? Right now, there are 2 ways to transfer tokens cross-chain: -1. via interoperability among different chains. After the latest “Archimedes” upgrade, [BEP3](https://https://github.com/bnb-chain/BEPs/blob/master/BEP3.md) was introduced and it defines native transactions to support [Hash Timelock Contract (HTLC)](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) on Beacon Chain and it also to defines the infrastructure standard and procedure to use HTLC for inter-chain [atomic swap](https://www.binance.vision/blockchain/atomic-swaps-explained) to easily swap tokens on different chains. Beacon Chain development community has finished implementing its solution for BEP3 with BEP2 and ERC20 tokens and decided to open-source all of the key components, including： +1. via interoperability among different chains. After the latest “Archimedes” upgrade, [BEP3](https://https://github.com/bnb-chain/BEPs/blob/master/BEP3.md) was introduced and it defines native transactions to support [Hash Timelock Contract (HTLC)](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) on BNB Beacon Chain and it also to defines the infrastructure standard and procedure to use HTLC for inter-chain [atomic swap](https://www.binance.vision/blockchain/atomic-swaps-explained) to easily swap tokens on different chains. BNB Beacon Chain development community has finished implementing its solution for BEP3 with BEP2 and ERC20 tokens and decided to open-source all of the key components, including： * [smart-contract solution](https://github.com/bnb-chain/bep3-smartcontracts) that supports Atomic Peg Swap (APS) for Ethereum. Please note that this solution is already audited by 3rd party. * [deputy process](https://github.com/bnb-chain/bep3-deputy) written in GoLang that handles swap activities Any developer is welcome to test the solutions in testnet and then use them in mainnet. -1. via Binance.com. [Binance](https://wwww.binance.com),the largest cryptocurrency exchange, has issued a number of crypto-pegged tokens on Beacon Chain (BEP2 token format): [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), [BEP2 BCH](https://explorer.binance.org/asset/BCH-1FD),[BEP2 XRP](https://explorer.binance.org/asset/XRP-BF2), [BEP2 LTC](https://explorer.binance.org/asset/LTC-F07). Pegged tokens such as [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), are 100% backed by the native coin in [reserve](https://btc.com/3LYJfcfHPXYJreMsASk2jkn69LWEYKzexb). The reserve addresses are published for anyone to audit. Read this [blog](https://www.binance.com/en/blog/347360878904684544/Introducing-BitcoinPegged-Token-on-Binance-Chain) to learn about the reserved address. Users are free to convert between native and BEP2 Bitcoin via deposit/withdrawal. This has a higher degree of ease-of-use for most traders. More swap channels will be provided on partner wallets soon. +1. via Binance.com. [Binance](https://wwww.binance.com),the largest cryptocurrency exchange, has issued a number of crypto-pegged tokens on BNB Beacon Chain (BEP2 token format): [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), [BEP2 BCH](https://explorer.binance.org/asset/BCH-1FD),[BEP2 XRP](https://explorer.binance.org/asset/XRP-BF2), [BEP2 LTC](https://explorer.binance.org/asset/LTC-F07). Pegged tokens such as [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), are 100% backed by the native coin in [reserve](https://btc.com/3LYJfcfHPXYJreMsASk2jkn69LWEYKzexb). The reserve addresses are published for anyone to audit. Read this [blog](https://www.binance.com/en/blog/347360878904684544/Introducing-BitcoinPegged-Token-on-Binance-Chain) to learn about the reserved address. Users are free to convert between native and BEP2 Bitcoin via deposit/withdrawal. This has a higher degree of ease-of-use for most traders. More swap channels will be provided on partner wallets soon. Atomic swap and this centralized approach are not exclusive to other decentralized approaches, which can also be implemented in parallel. There are many cross-chain solutions being developed and we are very interested in them. -Please do __NOT__ try to transfer anything on existing network to Beacon Chain testnet, you may experience loss by doing so, because testnet doesn't run with real coins. +Please do __NOT__ try to transfer anything on existing network to BNB Beacon Chain testnet, you may experience loss by doing so, because testnet doesn't run with real coins. ### How is a trading pair created on Binance DEX? @@ -356,7 +356,7 @@ full nodes with the same, deterministic matching logic. Simply allowing trading between two assets seems easy enough, however it is expensive for not only the network but also its users in long term (and liquidity costs can be much larger). In order to efficiently use the -network, Beacon Chain only list assets against BNB and other widely accepted market quote assets. +network, BNB Beacon Chain only list assets against BNB and other widely accepted market quote assets. After an asset is issued, which costs a small fee, anyone can "propose" to all validators to list it against particular quote assets. @@ -366,8 +366,8 @@ Once the proposal is accepted, the owner of the base asset can list the trading For more information about this process please check the [listing guide](https://github.com/bnb-chain/bnb-chain.github.io/blob/master/docs/beaconchain/list.md). -### How would a third-party integrate with Beacon Chain and Binance DEX? +### How would a third-party integrate with BNB Beacon Chain and Binance DEX? -A wallet provider may choose to only support the feature set of Beacon Chain , which would just +A wallet provider may choose to only support the feature set of BNB Beacon Chain , which would just cover wallets, addresses, balances and transfers.
To improve their implementation further, they could choose to integrate Binance DEX which would add trading (order placement and cancellation), historical order and trade views, charts, etc. \ No newline at end of file diff --git a/docs/BSC-FAQs-general.md b/docs/BSC-FAQs-general.md index eb36f64fc8..381c904f03 100644 --- a/docs/BSC-FAQs-general.md +++ b/docs/BSC-FAQs-general.md @@ -8,11 +8,11 @@ sidebar_position: 2 ### What is BNB Smart Chain? -BNB Smart Chain brings EVM-compatible programmability and native cross-chain communication with Beacon Chain using an innovative consensus of Proof of Staked Authority (PoSA). +BNB Smart Chain brings EVM-compatible programmability and native cross-chain communication with BNB Beacon Chain using an innovative consensus of Proof of Staked Authority (PoSA). -### Why is BNB Smart Chain designed as a separate chain from Beacon Chain? +### Why is BNB Smart Chain designed as a separate chain from BNB Beacon Chain? -The execution of a Smart Contract may slow down the exchange function and add non-deterministic factors to trading. Even if that compromise could be tolerated, it might be a straightforward idea to introduce a new Virtual Machine specification based on Tendermint, based on the current underlying consensus protocol and major RPC implementation of Beacon Chain. But all these will increase the learning requirements for all existing dApp communities, and will not be very welcomed. +The execution of a Smart Contract may slow down the exchange function and add non-deterministic factors to trading. Even if that compromise could be tolerated, it might be a straightforward idea to introduce a new Virtual Machine specification based on Tendermint, based on the current underlying consensus protocol and major RPC implementation of BNB Beacon Chain. But all these will increase the learning requirements for all existing dApp communities, and will not be very welcomed. ### Where will the published whitepaper be found? @@ -31,7 +31,7 @@ The codebase of BSC is open-sourced here: ## What is the consensus model of BSC? -BNB Smart Chain is an innovative solution to bring programmability and interoperability to Beacon Chain. BNB Smart Chain relies on a system of 50 validators with Proof of Staked Authority (PoSA) consensus that can support short block time and lower fees. For more details, refer [here](learn/consensus.md). +BNB Smart Chain is an innovative solution to bring programmability and interoperability to BNB Beacon Chain. BNB Smart Chain relies on a system of 50 validators with Proof of Staked Authority (PoSA) consensus that can support short block time and lower fees. For more details, refer [here](learn/consensus.md). ## Where can I find some support? * Technical talk and support running our software: @@ -81,7 +81,7 @@ PoSA is a combination of PoA and PoS. Blocks are produced by a limited set of va * Fast block time, cheaper cost -* Native cross-chain transfer & communication: Binance DEX remains a liquid venue of exchange of assets on Beacon Chain and BNB Smart Chain " +* Native cross-chain transfer & communication: Binance DEX remains a liquid venue of exchange of assets on BNB Beacon Chain and BNB Smart Chain " ### What are the benefits for developers to build on BNB Chain? @@ -107,7 +107,7 @@ Key Innovations: EVM means Ethereum Virtual Machine. Any smart contract written to run in EVM can be easily ported to BNB Smart Chain. -### Can developers make hybrid Dapps using both Beacon Chain and BNB Smart Chain in one single Dapp? +### Can developers make hybrid Dapps using both BNB Beacon Chain and BNB Smart Chain in one single Dapp? Yes, with the help of native cross-chain functions @@ -147,7 +147,7 @@ Future coding competitions; Hackathons ### What are Pegged tokens on BNB Smart Chain? -Soon after the launch of Beacon Chain, BNB Chain issued several pegged BEP2 tokens that are running on other blockchain networks, including BTC (BTCB), ETH, XRP, LTC, BCH, and ONT. These tokens are backed by real tokens locked in public addresses and have allowed users to benefit from both the volatility of these tokens as well as the fast transfer and trading experience of Beacon Chain. +Soon after the launch of BNB Beacon Chain, BNB Chain issued several pegged BEP2 tokens that are running on other blockchain networks, including BTC (BTCB), ETH, XRP, LTC, BCH, and ONT. These tokens are backed by real tokens locked in public addresses and have allowed users to benefit from both the volatility of these tokens as well as the fast transfer and trading experience of BNB Beacon Chain. Current list: @@ -218,7 +218,7 @@ Please try to contact the support of the receiver address to help with the depos ## How to track Cross-chain transfer tx From BC to BSC? -1. Get the Cross-chain transfer transaction hash of the Beacon Chain +1. Get the Cross-chain transfer transaction hash of the BNB Beacon Chain For example https://explorer.binance.org/tx/8B9B066BAF9DC1C233A9D316C75E8139B985518868C1120B656C5B3EBAC7C498 diff --git a/docs/BSC-FAQs-tokens.md b/docs/BSC-FAQs-tokens.md index a7114fdfee..79ce54e178 100644 --- a/docs/BSC-FAQs-tokens.md +++ b/docs/BSC-FAQs-tokens.md @@ -4,7 +4,7 @@ hide_table_of_contents: false sidebar_position: 2 --- -# Tokens in Beacon Chain and BNB Smart Chain +# Tokens in BNB Beacon Chain and BNB Smart Chain ## What role does BNB play in securing BNB Smart Chain ? @@ -16,7 +16,7 @@ BNB is the native token for BSC, and pegged BEP2 tokens on BSC is called BEP20. ## What is BEP2? -A simple token protocol for easy management of asset on Beacon Chain +A simple token protocol for easy management of asset on BNB Beacon Chain BNB is BEP2 @@ -98,7 +98,7 @@ For example: https://api.binance.org/cross_chain/v1/tx/0xb6b941a3d44fec69902ea63 If "has_refund" is false, it means this transaction is successful. -The corresponding transaction hash on Beacon chain is “cross_chain_tx_hash" +The corresponding transaction hash on BNB Beacon Chain is “cross_chain_tx_hash" The tokens were sent to “receiverAddresses”. diff --git a/docs/BSC-FAQs.md b/docs/BSC-FAQs.md index 95c8053d47..cffefa70fe 100644 --- a/docs/BSC-FAQs.md +++ b/docs/BSC-FAQs.md @@ -6,11 +6,11 @@ sidebar_position: 2 ## What is BNB Smart Chain ? -BNB Smart Chain brings EVM-compatible programmability and native cross-chain communication with Beacon Chain using an innovative consensus of Proof of Staked Authority(PoSA). +BNB Smart Chain brings EVM-compatible programmability and native cross-chain communication with BNB Beacon Chain using an innovative consensus of Proof of Staked Authority(PoSA). -## Why is BNB Smart Chain designed as a separate chain from Beacon Chain ? +## Why is BNB Smart Chain designed as a separate chain from BNB Beacon Chain ? -The execution of a Smart Contract may slow down the exchange function and add non-deterministic factors to trading. Even if that compromise could be tolerated, it might be a straightforward idea to introduce a new Virtual Machine specification based on Tendermint, based on the current underlying consensus protocol and major RPC implementation of Beacon Chain . But all these will increase the learning requirements for all existing dApp communities, and will not be very welcomed. +The execution of a Smart Contract may slow down the exchange function and add non-deterministic factors to trading. Even if that compromise could be tolerated, it might be a straightforward idea to introduce a new Virtual Machine specification based on Tendermint, based on the current underlying consensus protocol and major RPC implementation of BNB Beacon Chain . But all these will increase the learning requirements for all existing dApp communities, and will not be very welcomed. ## Where will the published whitepaper be found? @@ -75,7 +75,7 @@ PoSA is a combination of PoA and PoS. Blocks are produced by a limited set of va * EVM-compatible: BNB Smart Chain supports all the existing Ethereum tooling Fast block time, cheaper cost -* Native cross-chain trasfer & communication: Binance DEX remains a liquid venue of exchange of assets on Beacon Chain and BNB Smart Chain " +* Native cross-chain trasfer & communication: Binance DEX remains a liquid venue of exchange of assets on BNB Beacon Chain and BNB Smart Chain " ## What are the benefits for developers to build on BNB Chain ? @@ -101,7 +101,7 @@ Key Innovations: EVM means Ethereum Virtual Machine. Any smart-contract written to run in EVM can be easily ported to BNB Smart Chain . -## Can developers make hybrid Dapps using both Beacon Chain and BNB Smart Chain in one single Dapp? +## Can developers make hybrid Dapps using both BNB Beacon Chain and BNB Smart Chain in one single Dapp? Yes, with the help of native cross-chain functions diff --git a/docs/api-reference/cli.md b/docs/api-reference/cli.md index b5ec7691ee..52db8ce6b9 100644 --- a/docs/api-reference/cli.md +++ b/docs/api-reference/cli.md @@ -1,12 +1,12 @@ # Command Line Interface (CLI) -BNB CLI is one of several ways to interact with Beacon Chain. +BNB CLI is one of several ways to interact with BNB Beacon Chain. BNB CLI can be used as a local wallet, you can manage your keys via Beacon CLI. You can add a new key or restore your key from mnemonic words. And you can list your keys and show specified key info. -With BNB CLI, you can send transactions to Beacon Chain, like placing an order, transferring token, -issuing token and so on. Actually you can do almost everything you can do with Beacon Chain web wallet. What is +With BNB CLI, you can send transactions to BNB Beacon Chain, like placing an order, transferring token, +issuing token and so on. Actually you can do almost everything you can do with BNB Beacon Chain web wallet. What is more, you can propose to list trading pairs and join chain governance. In addition, you can do some simple queries through CLI. For example, you can query your account's @@ -48,9 +48,9 @@ C:\> tbnbcli.exe ## Where to connect -You can manage you keys locally without connecting to any node. But if you want to interact with Beacon Chain, you need to connect to one of Beacon Chain full nodes. +You can manage you keys locally without connecting to any node. But if you want to interact with BNB Beacon Chain, you need to connect to one of BNB Beacon Chain full nodes. -You can run your own full node, which may automatically connect to Beacon Chain, and you can run your CLI there with your own full node. In the mean time, you can connect to any full nodes provided by other people. +You can run your own full node, which may automatically connect to BNB Beacon Chain, and you can run your CLI there with your own full node. In the mean time, you can connect to any full nodes provided by other people. You could query this API for for a list of full node on mainnet: . diff --git a/docs/api-reference/dex-api/paths.md b/docs/api-reference/dex-api/paths.md index 0bc47e65d3..b7e2e33cfd 100644 --- a/docs/api-reference/dex-api/paths.md +++ b/docs/api-reference/dex-api/paths.md @@ -1,6 +1,6 @@ HTTP API ======== -Within the ecosystem of Beacon Chain, there are several accelerated nodes which provides more secure and faster lines to access Beacon Chain and DEX data service including HTTP API. +Within the ecosystem of BNB Beacon Chain, there are several accelerated nodes which provides more secure and faster lines to access BNB Beacon Chain and DEX data service including HTTP API. For mainnet, there are more accelerated nodes. @@ -656,7 +656,7 @@ If the time window is larger than limits, only the first n klines will return. I ### /api/v1/transactions --- -**Note:** This endpoint will be retired soon, use [this api](https://docs.binance.org/api-reference/dex-api/block-service.html#apiv1txs) instead (please read the migration guide). +**Note:** This endpoint will be retired soon, use [this api](https://docs.bnbchain.org/api-reference/dex-api/block-service.html#apiv1txs) instead (please read the migration guide). ##### ***GET*** **Summary:** Get transactions. @@ -694,7 +694,7 @@ If the time window is larger than limits, only the first n klines will return. I ### /api/v1/transactions-in-block/{blockHeight} --- -**Note:** This endpoint will be retired soon, use [this api](https://docs.binance.org/api-reference/dex-api/block-service.html#apiv1blocksblockheighttxs) instead (please read the migration guide). +**Note:** This endpoint will be retired soon, use [this api](https://docs.bnbchain.org/api-reference/dex-api/block-service.html#apiv1blocksblockheighttxs) instead (please read the migration guide). ##### ***GET*** **Summary:** Get transactions in the specific block. @@ -723,7 +723,7 @@ If the time window is larger than limits, only the first n klines will return. I ### /api/v2/transactions-in-block/{blockHeight} -**Note:** This endpoint will be retired soon, use [this api](https://docs.binance.org/api-reference/dex-api/block-service.html#apiv1blocksblockheighttxs) instead (please read the migration guide). +**Note:** This endpoint will be retired soon, use [this api](https://docs.bnbchain.org/api-reference/dex-api/block-service.html#apiv1blocksblockheighttxs) instead (please read the migration guide). --- ##### ***GET*** diff --git a/docs/api-reference/node-rpc.md b/docs/api-reference/node-rpc.md index 9b3544f1c4..cbc94b43b3 100644 --- a/docs/api-reference/node-rpc.md +++ b/docs/api-reference/node-rpc.md @@ -10,11 +10,11 @@ There are two main ways to connect to a node to send RPC commands. This page assumes that you have your own node running locally, so examples here use `localhost:27146` to represent using RPC commands on a local node. -Alternatively, you are able to use a node that is hosted in the Beacon Chain network. +Alternatively, you are able to use a node that is hosted in the BNB Beacon Chain network. ### 1.2 Use an existing node on the network -The Beacon Chain infrastructure deployment contains so-called "data seed" nodes, which have their RPC ports available for access. To find a seed node that is available, you can use the [peers](./dex-api/paths.md#apiv1peers) endpoint to get a list of network peers. +The BNB Beacon Chain infrastructure deployment contains so-called "data seed" nodes, which have their RPC ports available for access. To find a seed node that is available, you can use the [peers](./dex-api/paths.md#apiv1peers) endpoint to get a list of network peers. Here is an example of a node that is available for RPC access. The following is the output of `localhost:27147/status`: @@ -685,7 +685,7 @@ genesis, err := client.Genesis() "app_state": { "tokens": [ { - "name": "Beacon Chain Native Token", + "name": "BNB Beacon Chain Native Token", "symbol": "BNB", "total_supply": "20000000000000000", "owner": "tbnb12hlquylu78cjylk5zshxpdj6hf3t0tahwjt3ex", @@ -1738,7 +1738,7 @@ The account balance information is the following: {"type":"bnbchain/Account","value":{"base":{"address":"tbnb1sylyjw032eajr9cyllp26n04300qzzre38qyv5","coins":[{"denom":"000-0E1","amount":"10530"},{"denom":"AGRI-BD2","amount":"102842693026"},{"denom":"ALIS-95B","amount":"1008261"},{"denom":"ANN-457","amount":"10100000000000"},{"denom":"AVT-B74","amount":"2280343"},{"denom":"BC1-3A1","amount":"1826704"},{"denom":"BNB","amount":"10221947267999"},{"denom":"BNN-411","amount":"10100000000000"},{"denom":"BTC.B-918","amount":"113218800"},{"denom":"BTMGL-C72","amount":"204562981873"},{"denom":"CNN-210","amount":"10100000000000"},{"denom":"COSMOS-587","amount":"50000101983748977"},{"denom":"DC1-4B8","amount":"1826704"},{"denom":"DUIT-31C","amount":"121112394964"},{"denom":"EDU-DD0","amount":"139885964"},{"denom":"FRI-D5F","amount":"11251373129"},{"denom":"IAA-C81","amount":"9448420"},{"denom":"IBB-8DE","amount":"9448420"},{"denom":"ICC-6EF","amount":"9448420"},{"denom":"IDD-516","amount":"9448420"},{"denom":"IEE-DCA","amount":"9448420"},{"denom":"IFF-804","amount":"9448420"},{"denom":"IGG-013","amount":"9448420"},{"denom":"IHH-D4E","amount":"9448420"},{"denom":"III-25C","amount":"9448420"},{"denom":"IJJ-65E","amount":"9448420"},{"denom":"KOGE48-35D","amount":"10000000000"},{"denom":"LC1-7FC","amount":"1826704"},{"denom":"LCQ-AC5","amount":"9133568718"},{"denom":"MFH-9B5","amount":"1258976083286"},{"denom":"NASC-137","amount":"0"},{"denom":"NC1-279","amount":"1826704"},{"denom":"NC2-249","amount":"1411566"},{"denom":"OCB-B95","amount":"10000000000"},{"denom":"PIC-F40","amount":"102842693026"},{"denom":"PPC-00A","amount":"205150260"},{"denom":"RBT-CB7","amount":"1008261"},{"denom":"RC1-943","amount":"1826704"},{"denom":"RC1-A1E","amount":"1826704"},{"denom":"RC1-F49","amount":"1826704"},{"denom":"SVC-A14","amount":"18267042"},{"denom":"TC1-F43","amount":"1826704"},{"denom":"TFA-3B4","amount":"5731324"},{"denom":"TGT-9FC","amount":"33251102828"},{"denom":"UCX-CC8","amount":"1398859649"},{"denom":"UDO-638","amount":"5041308481"},{"denom":"USDT.B-B7C","amount":"138793116268"},{"denom":"WWW76-A8F","amount":"4611856"},{"denom":"XSX-072","amount":"10228149"},{"denom":"YLC-D8B","amount":"210572645"},{"denom":"ZEBRA-16D","amount":"1000"},{"denom":"ZZZ-21E","amount":"13988596"}],"public_key":{"type":"tendermint/PubKeySecp256k1","value":"AhOb3ZXecsIqwqKw+HhTscyi6K35xYpKaJx10yYwE0Qa"},"account_number":"406226","sequence":"52"},"name":"","frozen":null,"locked":[{"denom":"BNB","amount":"800"}]}} ``` -You can also query from `/account/`. This is how [go-sdk](https://github.com/binance-chain/go-sdk/blob/master/client/rpc/dex_client.go#L144) handles balance query, because it relects account changes which are not committed in a block too. +You can also query from `/account/`. This is how [go-sdk](https://github.com/bnb-chain/go-sdk/blob/master/client/rpc/dex_client.go#L144) handles balance query, because it relects account changes which are not committed in a block too. ```shell curl 'https://data-seed-pre-0-s3.binance.org/abci_query?path="/account/tbnb1hn8ym9xht925jkncjpf7lhjnax6z8nv2mu9wy3"' @@ -2368,7 +2368,7 @@ You need to enable indexer in `config.tml`. You can modify the `index_tags` to i **Available Query Path** -Right now, you can only query by transaction height: `tx.height`. Please note that on Beacon Chain testnet, you can only use this data seed node for tx search: +Right now, you can only query by transaction height: `tx.height`. Please note that on BNB Beacon Chain testnet, you can only use this data seed node for tx search: **Example** diff --git a/docs/api-reference/sdk.md b/docs/api-reference/sdk.md index 6a8debabec..f69e2858d6 100644 --- a/docs/api-reference/sdk.md +++ b/docs/api-reference/sdk.md @@ -2,13 +2,13 @@ Here the client SDK is used to connect to BNB Beacon Chain and DEX. There are libraries in a few programming languages, including: -- [Go](https://github.com/binance-chain/go-sdk)([Documentation](https://github.com/binance-chain/go-sdk/wiki)) -- [Java](https://github.com/binance-chain/java-sdk)([Documentation](https://github.com/binance-chain/java-sdk/wiki)) -- [Javascript](https://github.com/binance-chain/javascript-sdk) ([Documentation](https://github.com/binance-chain/javascript-sdk/wiki)) -- [C++](https://github.com/binance-chain/cplusplus-sdk)([Documentation](https://github.com/binance-chain/cplusplus-sdk/wiki)) -- [C#](https://github.com/binance-chain/csharp-sdk)([Documentation](https://github.com/binance-chain/csharp-sdk)) -- [Python](https://github.com/binance-chain/python-sdk)([Documentation](https://python-binance-chain.readthedocs.io/en/latest/binance-chain.html#module-binance_chain)) -- [Swift](https://github.com/binance-chain/swift-sdk)([Documentation](https://github.com/binance-chain/swift-sdk/blob/master/README.md)) +- [Go](https://github.com/bnb-chain/go-sdk)([Documentation](https://github.com/bnb-chain/go-sdk/wiki)) +- [Java](https://github.com/bnb-chain/java-sdk)([Documentation](https://github.com/bnb-chain/java-sdk/wiki)) +- [Javascript](https://github.com/bnb-chain/javascript-sdk) ([Documentation](https://github.com/bnb-chain/javascript-sdk/wiki)) +- [C++](https://github.com/bnb-chain/cplusplus-sdk)([Documentation](https://github.com/bnb-chain/cplusplus-sdk/wiki)) +- [C#](https://github.com/bnb-chain/csharp-sdk)([Documentation](https://github.com/bnb-chain/csharp-sdk)) +- [Python](https://github.com/bnb-chain/python-sdk)([Documentation](https://python-binance-chain.readthedocs.io/en/latest/binance-chain.html#module-binance_chain)) +- [Swift](https://github.com/bnb-chain/swift-sdk)([Documentation](https://github.com/bnb-chain/swift-sdk/blob/master/README.md)) If you write one for another language, welcome to share it! diff --git a/docs/beaconchain/acknowledgement.md b/docs/beaconchain/acknowledgement.md index 3ecd3e1c2c..b83752c61f 100644 --- a/docs/beaconchain/acknowledgement.md +++ b/docs/beaconchain/acknowledgement.md @@ -1,5 +1,5 @@ # Acknowledgements -Beacon Chain has been through several iterations and evolutions, each time building upon work contributed by members of the blockchain community. We would like to acknowledge the outstanding work that we have been able to achieve during development. Let's build the future together! +BNB Beacon Chain has been through several iterations and evolutions, each time building upon work contributed by members of the blockchain community. We would like to acknowledge the outstanding work that we have been able to achieve during development. Let's build the future together! ## Bitcoin and Ethereum There is no doubt that these two projects and their communities provided us from day one with countless creativity. They are the root and ground-zero of thought and keep providing us with brilliant utilities and ideas. @@ -10,7 +10,7 @@ The Binance Dexathon concluded in September 2018, receiving prize winning submis ## Tendermint and Cosmos Our current implementation is built on forks of Tendermint and Cosmos SDK. We make use of a revised edition of Tendermint consensus and leverage its p2p networking logic, and Cosmos SDK features such as "bank" which is used for basic token transactions. Some of the changes have been contributed back to the projects. -Projects like Beacon Chain and Binance DEX are often built as forks of Bitcoin or as smart contracts on platforms like Ethereum. With a foundation of clean, well-structured code from Cosmos SDK, we were able to build on a codebase that we saw as a better alternative. Many thanks to the Cosmos developers and its community for their work (and for being really helpful in our issues and pull requests!) +Projects like BNB Beacon Chain and Binance DEX are often built as forks of Bitcoin or as smart contracts on platforms like Ethereum. With a foundation of clean, well-structured code from Cosmos SDK, we were able to build on a codebase that we saw as a better alternative. Many thanks to the Cosmos developers and its community for their work (and for being really helpful in our issues and pull requests!) ## Juan Leni, ZondaX Thanks to Juan Leni for his work on the open-source [Cosmos Ledger app](https://github.com/ZondaX/ledger-cosmos-app), which we were able to use as a base for the BNB Beacon Chain Ledger app. diff --git a/docs/beaconchain/atomic-swap.md b/docs/beaconchain/atomic-swap.md index efb2ae6194..e6a8c70368 100644 --- a/docs/beaconchain/atomic-swap.md +++ b/docs/beaconchain/atomic-swap.md @@ -1,7 +1,7 @@ ## Introduction -As explained in [BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md), Hash Timer Locked Contract(HTLC) has been used for Atomic Swap and cross payment channels between different blockchains. BEP3 defines native transactions to support HTLC on Beacon Chain and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token. +As explained in [BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md), Hash Timer Locked Contract(HTLC) has been used for Atomic Swap and cross payment channels between different blockchains. BEP3 defines native transactions to support HTLC on BNB Beacon Chain and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token. During the swap process, the related fund will be locked to a purely-code-controlled escrow account. -A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in Beacon chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): +A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in BNB Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): ``` AtomicSwapCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("BinanceChainAtomicSwapCoins"))) ``` @@ -11,7 +11,7 @@ The account for mainnet is: **bnb1wxeplyw7x8aahy93w96yhwm7xcq3ke4f8ge93u** and t ### Hash Timer Locked Transfer -Hash Timer Locked Transfer (HTLT) is a new transaction type on Beacon Chain, to serve as HTLC in the first step of Atomic Swap, +Hash Timer Locked Transfer (HTLT) is a new transaction type on BNB Beacon Chain, to serve as HTLC in the first step of Atomic Swap, #### Parameters @@ -94,9 +94,9 @@ Data:[77 137 139 200 85 141 170 77 129 116 134 215 169 59 119 178 200 47 206 194 swapID: 4d898bc8558daa4d817486d7a93b77b2c82fcec2123abf4a1eb7d2521237eccd ``` -2. Swap from Beacon Chain to Ethereum +2. Swap from BNB Beacon Chain to Ethereum -* Clients send HTLT on Beacon Chain on *testnet*: +* Clients send HTLT on BNB Beacon Chain on *testnet*: Command line: ```shell @@ -123,11 +123,11 @@ Javascript: const res = client.swap.HTLT(from, recipient, recipientOtherChain, "", randomNumberHash, timestamp, amount, expectedIncome, heightSpan, true) ``` -3. Swap from Ethereum to Beacon Chain +3. Swap from Ethereum to BNB Beacon Chain > Note: Once cross-chain is true, --recipient-other-chain must not be empty -* Deputy send HTLT on Beacon Chain on *testnet*: +* Deputy send HTLT on BNB Beacon Chain on *testnet*: Command line: ```shell @@ -398,9 +398,9 @@ refundHTLT | N/A | 0.000375 BNB | Y * ERC20 contract has been deployed here: * Token Symbol: **PPC** * SmartContract has been deployed here: -* Its corresponding address on testnet is: `tbnb1pk45lc2k7lmf0pnfa59l0uhwrvpk8shsema7gr`on Beacon Chain and `0xD93395B2771914E1679155F3EA58C41d89D96098` on Ethereum testnet +* Its corresponding address on testnet is: `tbnb1pk45lc2k7lmf0pnfa59l0uhwrvpk8shsema7gr`on BNB Beacon Chain and `0xD93395B2771914E1679155F3EA58C41d89D96098` on Ethereum testnet -### Swap Tokens from Ethereum to Beacon Chain +### Swap Tokens from Ethereum to BNB Beacon Chain ![image-20190918193751444](../assets/eth2bnc.png) #### 1. Approve Swap Transaction @@ -431,12 +431,12 @@ Go to [smartcontract](https://ropsten.etherscan.io/address/0xd93395b2771914e1679 Example of `htlt` [transaction](https://ropsten.etherscan.io/tx/0xa2444cc1e52e09027ec68bf8955e7084235255f9f18d9b837a12fd63e6f0145c) -#### 3. Deputy Call HTLT on Beacon Chain +#### 3. Deputy Call HTLT on BNB Beacon Chain Then, Deputy will send `HTLT` transaction [here](https://testnet-explorer.binance.org/tx/99CBC2896F0CF14DDAB0684BDA0A3E9FF2271056E68EC3559AB7FB24E0EE97DE) -#### 4. Claim HTLT on Beacon Chain +#### 4. Claim HTLT on BNB Beacon Chain -* Get the `swapID` on Beacon Chain +* Get the `swapID` on BNB Beacon Chain ``` ./tbnbcli token query-swapIDs-by-recipient --recipient-addr tbnb1cs0j4p0p6d3fvd77zg3qzlwwgmrv3e9e63423w --chain-id Binance-Chain-Ganges --trust-node --node http://data-seed-pre-0-s3.binance.org:80 @@ -487,7 +487,7 @@ You can also get swapID by [calculateSwapID in javascript-sdk](https://github.co - `out_amount` should be reasonable. Please note that the decimals of bep2 tokens is 8, the out_amount should be something around 10000000000:PPC, deputy will deduct some fees. - `expire_height` must not be passed and should be enough for send claim transaction -* Send claim transaction on Beacon Chain +* Send claim transaction on BNB Beacon Chain ``` ./tbnbcli token claim --swap-id 12aacc3bdc2cef97e8e45cc9b409796df57904a4e9c76863ad8420ff75f13128 --random-number --from --chain-id Binance-Chain-Ganges --trust-node --node http://data-seed-pre-0-s3.binance.org:80 @@ -579,7 +579,7 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten await wait(20000) //---------------------------------------------------------------------------- - //Step3 query swap created by deputy on Beacon Chain and verify swap parameters + //Step3 query swap created by deputy on BNB Beacon Chain and verify swap parameters //---------------------------------------------------------------------------- const swapID = calculateSwapID(randomNumberHash.replace("0x", ""), deputyBNBWalletAddr, clientEthWalletAddr).toString() console.log(swapID) @@ -599,7 +599,7 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten expect(Number(atomicSwap.result.expireHeight)).toBeGreaterThan(Number(status.sync_info.latest_block_height)+100) //---------------------------------------------------------------------------- - //Step4 claim on Beacon Chain + //Step4 claim on BNB Beacon Chain //---------------------------------------------------------------------------- const res = await bnbClient.swap.claimHTLT(clientBnbWalletAddr, swapID, randomNumber) console.log(res) @@ -609,10 +609,10 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten //---------------------------------------------------------------------------- ``` -### Swap Tokens from Beacon Chain to Ethereum +### Swap Tokens from BNB Beacon Chain to Ethereum ![image-20190918193910521](../assets/bnc2eth.png) -#### 1. Send `HTLT` Transaction from Beacon Chain +#### 1. Send `HTLT` Transaction from BNB Beacon Chain Please read this [section](#hash-timer-locked-transfer) to generate a valid `HTLT` transaction. Please write down the `randomNumber` and `randomNumberHash`. @@ -660,9 +660,9 @@ You should see that **Deputy** has already approved enough tokens and In its [event log](https://ropsten.etherscan.io/tx/0x142fb8db7eb66feb241ca710a028678e36595fc8aea03858672288fcac8e4494#eventlog), you should see the `swapID`. Before calling `claim` function on ethereum, clients should verify the parameters in the `HTLT` event. -- `_randomNumberHash` must equal to the randomNumberHash in client HTLT transaction on Beacon Chain +- `_randomNumberHash` must equal to the randomNumberHash in client HTLT transaction on BNB Beacon Chain - `_recipientAddr` must equal to client ethereum wallet address -- `_timestamp` must equal to the timestamp in client HTLT transaction on Beacon Chain +- `_timestamp` must equal to the timestamp in client HTLT transaction on BNB Beacon Chain - `_outAmount` should be reasonable. Please note that the decimals erc20 contract and deputy will deduct some fees. - `_expireHeight` must not be passed and should be enough for send claim transaction @@ -675,7 +675,7 @@ Then, you can call the `claim` function: Example is [here](https://ropsten.etherscan.io/tx/0x9cf7cc7891b86987c4eef59e3b4950324d656e6937a38b91786894f52c76f41b) -#### 5. Deputy Claim on Beacon Chain +#### 5. Deputy Claim on BNB Beacon Chain `Claim HTLT` transaction from **Deputy** is [sent](https://testnet-explorer.binance.org/tx/8C616DEFD2EAA41E13D2DC4844B218DFF8CFE24B4C7A693AAD700381B5FF7B48) afterwards: @@ -708,7 +708,7 @@ This is a javascript implementation of client app to swap [PPC-00A](https://tes const swapContract = new web3.eth.Contract([{"constant":true,"inputs":[],"name":"ERC20ContractAddr","outputs":[{"name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"isSwapExist","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"refund","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_swapSender","type":"address"},{"name":"_bep2SenderAddr","type":"bytes20"}],"name":"calSwapID","outputs":[{"name":"","type":"bytes32"}],"payable":false,"stateMutability":"pure","type":"function"},{"constant":false,"inputs":[{"name":"_swapID","type":"bytes32"},{"name":"_randomNumber","type":"bytes32"}],"name":"claim","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_timestamp","type":"uint64"},{"name":"_heightSpan","type":"uint256"},{"name":"_recipientAddr","type":"address"},{"name":"_bep2SenderAddr","type":"bytes20"},{"name":"_bep2RecipientAddr","type":"bytes20"},{"name":"_outAmount","type":"uint256"},{"name":"_bep2Amount","type":"uint256"}],"name":"htlt","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"claimable","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"refundable","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"queryOpenSwap","outputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_timestamp","type":"uint64"},{"name":"_expireHeight","type":"uint256"},{"name":"_outAmount","type":"uint256"},{"name":"_sender","type":"address"},{"name":"_recipient","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"inputs":[{"name":"_erc20Contract","type":"address"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"},{"indexed":false,"name":"_timestamp","type":"uint64"},{"indexed":false,"name":"_bep2Addr","type":"bytes20"},{"indexed":false,"name":"_expireHeight","type":"uint256"},{"indexed":false,"name":"_outAmount","type":"uint256"},{"indexed":false,"name":"_bep2Amount","type":"uint256"}],"name":"HTLT","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"}],"name":"Refunded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"},{"indexed":false,"name":"_randomNumber","type":"bytes32"}],"name":"Claimed","type":"event"}], swapContractAddr) //-------------------------------------------- - //Step1 send htlt on Beacon Chain + //Step1 send htlt on BNB Beacon Chain //-------------------------------------------- const randomNumber = "e8eae926261ab77d018202434791a335249b470246a7b02e28c3b2fb6ffad8f3" const timestamp = Math.floor(Date.now()/1000) @@ -767,7 +767,7 @@ This is a javascript implementation of client app to swap [PPC-00A](https://tes await wait(20000) //---------------------------------------------------------------------------- - //If step2 or step3 are failed and the expire height on Beacon Chain is passed, try to send refundHTLT transaction on Beacon Chain + //If step2 or step3 are failed and the expire height on BNB Beacon Chain is passed, try to send refundHTLT transaction on BNB Beacon Chain //---------------------------------------------------------------------------- ``` diff --git a/docs/beaconchain/bc-tutorials.md b/docs/beaconchain/bc-tutorials.md index 0b93539628..4338fba213 100644 --- a/docs/beaconchain/bc-tutorials.md +++ b/docs/beaconchain/bc-tutorials.md @@ -4,7 +4,7 @@ hide_table_of_contents: false --- # Tutorials -In this section, we have provided tutorials on usage of different components of Beacon Chain. +In this section, we have provided tutorials on usage of different components of BNB Beacon Chain. ### Full Node * Tutorial on [How to Run Full Node on BNB Beacon Chain Mainnet](develop/node/join-mainnet.md) @@ -17,7 +17,7 @@ In this section, we have provided tutorials on usage of different components of * Tutorial on [How to Run Light Client on BNB Beacon Chain](light-client.md) ### Wallets * [List of Supported Wallets](wallets) - * Tutorial on [How to Use Trust Wallet with Beacon Chain](wallet/tutorial/how-to-create-a-wallet-on-trustwallet) - * Tutorial on [How to Use Ledger Nano S Hardware Wallet with Beacon Chain](wallet/tutorial/ledger-nano-s-usage-guide) - * Tutorial on [How to Use Trezor Hardware Wallet with Beacon Chain](wallet/tutorial/trezor-model-t-user-guide) + * Tutorial on [How to Use Trust Wallet with BNB Beacon Chain](wallet/tutorial/how-to-create-a-wallet-on-trustwallet) + * Tutorial on [How to Use Ledger Nano S Hardware Wallet with BNB Beacon Chain](wallet/tutorial/ledger-nano-s-usage-guide) + * Tutorial on [How to Use Trezor Hardware Wallet with BNB Beacon Chain](wallet/tutorial/trezor-model-t-user-guide) * Tutorial on [How to manage your BEP8 tokens in BNB Chain Testnet Web Wallet](wallet/tutorial/bep8) diff --git a/docs/beaconchain/blockchain.md b/docs/beaconchain/blockchain.md index e02f25f6b6..9aeac240e7 100644 --- a/docs/beaconchain/blockchain.md +++ b/docs/beaconchain/blockchain.md @@ -1,10 +1,10 @@ -# The Beacon Chain Blockchain +# The BNB Beacon Chain Blockchain -The purpose of the Beacon Chain blockchain and DEX is to create an alternative marketplace for issuing and exchanging digital assets in a decentralized manner. +The purpose of the BNB Beacon Chain blockchain and DEX is to create an alternative marketplace for issuing and exchanging digital assets in a decentralized manner. ## Consensus Details -Beacon Chain is a peer-to-peer distributed system, connecting together multiple clients that reach consensus on their views of the "state of the world". Beacon Chain uses [Tendermint](https://github.com/tendermint/tendermint) BFT consensus and has a dedicated `application layer` that runs upon it. A simplified overview of the application's architecture might look something like this: +BNB Beacon Chain is a peer-to-peer distributed system, connecting together multiple clients that reach consensus on their views of the "state of the world". BNB Beacon Chain uses [Tendermint](https://github.com/tendermint/tendermint) BFT consensus and has a dedicated `application layer` that runs upon it. A simplified overview of the application's architecture might look something like this: ``` +------------+-----------+ @@ -39,7 +39,7 @@ You can consider Validator as "miner" in Bitcoin and Ethereum and similar concep ### What is a Witness Node? -Witness nodes represent the majority of nodes in a Beacon Chain deployment. Although they do not join the consensus process +Witness nodes represent the majority of nodes in a BNB Beacon Chain deployment. Although they do not join the consensus process and produce blocks, they take care of: - The witness consensus process. @@ -62,7 +62,7 @@ For mainnet, there are more accelerated nodes. ## Blocking -Beacon Chain uses a similar block structure as Tendermint proposes, with a size limit of 1 megabyte. +BNB Beacon Chain uses a similar block structure as Tendermint proposes, with a size limit of 1 megabyte. It is expected a block will be produced on a-few-of-seconds level among validators, and can include from 0 up to several thousands of transactions. @@ -88,26 +88,26 @@ For normal users, all the keys and addresses can be generated via [Binance Web W This default wallet would use a similar way to generate keys as Bitcoin, i.e. use 256 bits entropy to generate a 24-word mnemonic based on [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki), and then use the mnemonic and an empty passphrase to generate a seed; finally use the seed to generate a master key, and derive the private key using BIP32/BIP44 with HD prefix as `"44'/714'/"`, which is reserved at [SLIP 44](https://github.com/satoshilabs/slips/blob/master/slip-0044.md). #### Keys -Beacon Chain uses the same elliptic curve cryptography as the current [Bitcoin implementation](https://github.com/btcsuite/btcd/tree/master/btcec), i.e. `secp256k1`. Its private key is 32 bytes while public key is 33 bytes. +BNB Beacon Chain uses the same elliptic curve cryptography as the current [Bitcoin implementation](https://github.com/btcsuite/btcd/tree/master/btcec), i.e. `secp256k1`. Its private key is 32 bytes while public key is 33 bytes. #### Address -Addresses on Beacon Chain are 20 bytes and may be expressed as: +Addresses on BNB Beacon Chain are 20 bytes and may be expressed as: ``` Address = RIPEMD160(SHA256(compressed public key)) ``` Typically, an address is encoded in the [bech32](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) format which includes a checksum and human-readable prefix (HRP). However, it doesn't use the `SegWit` address format (because we do not have `SegWit` function anyway, so no `witness program version` etc.). -A Beacon Chain address is therefore more similar to a [Bitcoin Cash address](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md), which does not include a SegWit program script. +A BNB Beacon Chain address is therefore more similar to a [Bitcoin Cash address](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md), which does not include a SegWit program script. Address format pseudo-code: ``` Address_Bech32 = HRP + '1' + bech32.encode(convert8BitsTo5Bits(RIPEMD160(SHA256(compressed public key)))) ``` -For Beacon Chain address, the prefix is `bnb` for production network, and `tbnb` for testnet. +For BNB Beacon Chain address, the prefix is `bnb` for production network, and `tbnb` for testnet. #### Signature -Beacon Chain uses an ECDSA signature on curve secp256k1 against a `SHA256` hash of the byte array of a JSON-encoded canonical representation of the transaction. For more information, please see [this page](./encoding.md#canonical-bytes-for-signing). +BNB Beacon Chain uses an ECDSA signature on curve secp256k1 against a `SHA256` hash of the byte array of a JSON-encoded canonical representation of the transaction. For more information, please see [this page](./encoding.md#canonical-bytes-for-signing). diff --git a/docs/beaconchain/chain-access.md b/docs/beaconchain/chain-access.md index 17489ff63b..b7d5303fbc 100644 --- a/docs/beaconchain/chain-access.md +++ b/docs/beaconchain/chain-access.md @@ -1,10 +1,10 @@ -# How to Access Beacon Chain +# How to Access BNB Beacon Chain -[Get Started](get-started.md) pages already show how to access Beacon Chain and DEX via +[Get Started](get-started.md) pages already show how to access BNB Beacon Chain and DEX via Wallet and Explorers. Here we would like to dive into some technology details for access in a programming way. -There are 3 ways to read and write data from Beacon Chain : +There are 3 ways to read and write data from BNB Beacon Chain : ## Web API The `Accelerated Node` infrastructure provides easy access via http REST APIs and WebSocket @@ -12,7 +12,7 @@ push APIs. There are multiple endpoints from different validator's infrastructur check the [Web API Reference](api-reference/dex-api/paths.md) ## Node RPC -There are public data seed nodes that joins the Beacon Chain network. They usually +There are public data seed nodes that joins the BNB Beacon Chain network. They usually provide RPC calls. Please check the [Node RPC Reference](api-reference/node-rpc.md). You can also run a [full node](fullnode.md) by yourself, so that you will have a local server @@ -23,13 +23,13 @@ Essentially command line interfaces are just tools that wrap the incoming comman ## Write APIs -You can only write to Beacon Chain via `Transactions`. Both Web API and Node RPC provide -a `broadcastTx` API to submit a `signed and encoded` transaction onto the Beacon Chain . The detailed process is outlined below: +You can only write to BNB Beacon Chain via `Transactions`. Both Web API and Node RPC provide +a `broadcastTx` API to submit a `signed and encoded` transaction onto the BNB Beacon Chain . The detailed process is outlined below: ### Message Composition The transaction message and related information will be packed into `payload`, which is the so called [`Standard Transaction`](encoding.md#standard-transaction-to-use-and-encode-for-binance_chain). -The transaction body, memo, signature, etc. all fill in the `Standard Transaction`, encode and then broadcast out together onto Beacon Chain . +The transaction body, memo, signature, etc. all fill in the `Standard Transaction`, encode and then broadcast out together onto BNB Beacon Chain . ### Transaction Encoding Encoding defines the way how transactions are serialized and transferred between clients and nodes, @@ -41,7 +41,7 @@ Signature is the evidence to prove the sender owns the transaction. It will be c 1. Compose a data structure. please note `msgs`, `memo`, `source`, `data` are the same as in the above `payload`. - - `chain_id`: a string, unique ID for the Chain, it stays the same for most time, but may vary as Beacon Chain evolves; + - `chain_id`: a string, unique ID for the Chain, it stays the same for most time, but may vary as BNB Beacon Chain evolves; - `account_number`: a string for a 64-bit integer, an identifier number associated with the signing address - `sequence`: a string for a a 64-bit integer, please check [the below](#account_and_sequence_number) - `memo`: a string, a short sentence of remark for the transaction @@ -58,7 +58,7 @@ Signature is the evidence to prove the sender owns the transaction. It will be c 3. Sign SHA256 of the encoded byte array, to create an ECDSA signature on curve Secp256k1 and serialize the `R` and `S` result into a 64-byte array. (both `R` and `S` are encoded into 32-byte big endian integers, and then `R` is put into the first 32 bytes and `S` are put into the last 32 bytes of the byte array. In order to break `S` 's malleability, `S` set to `curve.Order() - S` if `S > curnve.Order()/2`.) -The `signature` will be encoded together with transaction message and sent as `payload` to Beacon Chain node via RPC or http REST API, as described in the above section. +The `signature` will be encoded together with transaction message and sent as `payload` to BNB Beacon Chain node via RPC or http REST API, as described in the above section. ## Account and Sequence Number @@ -67,7 +67,7 @@ After `Account` is [created](transfer.md#account_and_balance), besides the balan - Account Number: an internal identifier for the account - Sequence Number: an ever-changing integer. -The Sequence Number is the way how Beacon Chain prevents `Replay Attack` (the idea is borrowed from Cosmos +The Sequence Number is the way how BNB Beacon Chain prevents `Replay Attack` (the idea is borrowed from Cosmos network, but varies a bit in handling). Every transaction should have a new `Sequence Number` increased by 1 from the current latest sequence number of the `Account`, and after this transaction is recorded on the block chain, the `Sequence Number` will be set to the same number as the one of latest transaction. @@ -78,4 +78,4 @@ counting locally and re-synchronize from the blockchain periodically. ## Examples -[SDK](api-reference/sdk.md) in different languages are provided to simplify use of APIs to access Beacon Chain . +[SDK](api-reference/sdk.md) in different languages are provided to simplify use of APIs to access BNB Beacon Chain . diff --git a/docs/beaconchain/develop/api-reference/cli.md b/docs/beaconchain/develop/api-reference/cli.md index 391ab12c4f..69b1b82f50 100644 --- a/docs/beaconchain/develop/api-reference/cli.md +++ b/docs/beaconchain/develop/api-reference/cli.md @@ -1,20 +1,20 @@ # Command Line Interface (CLI) -Beacon Chain CLI is one of several ways to interact with Beacon Chain. +BNB Beacon Chain CLI is one of several ways to interact with BNB Beacon Chain. -Beacon Chain CLI can be used as a local wallet, you can manage your keys via Binance CLI. You can add a new +BNB Beacon Chain CLI can be used as a local wallet, you can manage your keys via Binance CLI. You can add a new key or restore your key from mnemonic words. And you can list your keys and show specified key info. -With Beacon Chain CLI, you can send transactions to Beacon Chain, like transferring tokens, -issuing tokens and so on. Actually you can do almost everything you can do with Beacon Chain web wallet. What is +With BNB Beacon Chain CLI, you can send transactions to BNB Beacon Chain, like transferring tokens, +issuing tokens and so on. Actually you can do almost everything you can do with BNB Beacon Chain web wallet. What is more, you can propose to list trading pairs and join chain governance. In addition, you can do some simple queries through CLI. For example, you can query your account's balance, transaction detail by transaction hash and etc. -## Where can I download the Beacon Chain CLI? +## Where can I download the BNB Beacon Chain CLI? -You can download Beacon Chain CLI releases here: [https://github.com/bnb-chain/node/releases](https://github.com/bnb-chain/node/releases) +You can download BNB Beacon Chain CLI releases here: [https://github.com/bnb-chain/node/releases](https://github.com/bnb-chain/node/releases) You can choose to download the version for testnet (`tbnbcli`) or mainnet (`bnblci`). @@ -48,9 +48,9 @@ C:\> tbnbcli.exe ## Where to connect -You can manage your keys locally without connecting to any node. But if you want to interact with Beacon Chain, you need to connect to one of Beacon Chain full nodes. +You can manage your keys locally without connecting to any node. But if you want to interact with BNB Beacon Chain, you need to connect to one of BNB Beacon Chain full nodes. -You can run your own full node, which may automatically connect to Beacon Chain, and you can run your CLI there with your own full node. In the mean time, you can connect to any full nodes provided by other people. +You can run your own full node, which may automatically connect to BNB Beacon Chain, and you can run your CLI there with your own full node. In the mean time, you can connect to any full nodes provided by other people. You could query this API for a list of full node on mainnet: . @@ -133,7 +133,7 @@ Please confirm if address displayed on ledger is identical to bnb15339dcwlq5nza4 ## How to use -When you have downloaded Beacon Chain CLI, you can use `help` subcommand to see all the available commands: +When you have downloaded BNB Beacon Chain CLI, you can use `help` subcommand to see all the available commands: ```bash $ ./bnbcli help diff --git a/docs/beaconchain/develop/api-reference/dex-api/migration-guide.md b/docs/beaconchain/develop/api-reference/dex-api/migration-guide.md index 3f534cc9a0..dc0c380007 100644 --- a/docs/beaconchain/develop/api-reference/dex-api/migration-guide.md +++ b/docs/beaconchain/develop/api-reference/dex-api/migration-guide.md @@ -1,7 +1,7 @@ # Migration Guide ## Target Audience -This guide will help users migrate their existing calls of [/api/v1/transactions-in-block](https://docs.binance.org/api-reference/dex-api/paths.html#apiv1transactions-in-blockblockheight), [/api/v2/transactions-in-block](https://docs.binance.org/api-reference/dex-api/paths.html#apiv2transactions-in-blockblockheight), [/api/v1/transactions](https://docs.binance.org/api-reference/dex-api/paths.html#apiv1transactions) to the new bock and transaction apis. +This guide will help users migrate their existing calls of [/api/v1/transactions-in-block](https://docs.bnbchain.org/api-reference/dex-api/paths.html#apiv1transactions-in-blockblockheight), [/api/v2/transactions-in-block](https://docs.bnbchain.org/api-reference/dex-api/paths.html#apiv2transactions-in-blockblockheight), [/api/v1/transactions](https://docs.bnbchain.org/api-reference/dex-api/paths.html#apiv1transactions) to the new bock and transaction apis. If you are also using undisclosed apis from [Explorer](https://explorer.binance.org), you can also refer to this document for migration. Otherwise, you can skip this document and refer to the api document. diff --git a/docs/beaconchain/develop/api-reference/node-rpc.md b/docs/beaconchain/develop/api-reference/node-rpc.md index 77c0f1f4e9..262eb0fe44 100644 --- a/docs/beaconchain/develop/api-reference/node-rpc.md +++ b/docs/beaconchain/develop/api-reference/node-rpc.md @@ -1738,7 +1738,7 @@ The account balance information is the following: {"type":"bnbchain/Account","value":{"base":{"address":"tbnb1sylyjw032eajr9cyllp26n04300qzzre38qyv5","coins":[{"denom":"000-0E1","amount":"10530"},{"denom":"AGRI-BD2","amount":"102842693026"},{"denom":"ALIS-95B","amount":"1008261"},{"denom":"ANN-457","amount":"10100000000000"},{"denom":"AVT-B74","amount":"2280343"},{"denom":"BC1-3A1","amount":"1826704"},{"denom":"BNB","amount":"10221947267999"},{"denom":"BNN-411","amount":"10100000000000"},{"denom":"BTC.B-918","amount":"113218800"},{"denom":"BTMGL-C72","amount":"204562981873"},{"denom":"CNN-210","amount":"10100000000000"},{"denom":"COSMOS-587","amount":"50000101983748977"},{"denom":"DC1-4B8","amount":"1826704"},{"denom":"DUIT-31C","amount":"121112394964"},{"denom":"EDU-DD0","amount":"139885964"},{"denom":"FRI-D5F","amount":"11251373129"},{"denom":"IAA-C81","amount":"9448420"},{"denom":"IBB-8DE","amount":"9448420"},{"denom":"ICC-6EF","amount":"9448420"},{"denom":"IDD-516","amount":"9448420"},{"denom":"IEE-DCA","amount":"9448420"},{"denom":"IFF-804","amount":"9448420"},{"denom":"IGG-013","amount":"9448420"},{"denom":"IHH-D4E","amount":"9448420"},{"denom":"III-25C","amount":"9448420"},{"denom":"IJJ-65E","amount":"9448420"},{"denom":"KOGE48-35D","amount":"10000000000"},{"denom":"LC1-7FC","amount":"1826704"},{"denom":"LCQ-AC5","amount":"9133568718"},{"denom":"MFH-9B5","amount":"1258976083286"},{"denom":"NASC-137","amount":"0"},{"denom":"NC1-279","amount":"1826704"},{"denom":"NC2-249","amount":"1411566"},{"denom":"OCB-B95","amount":"10000000000"},{"denom":"PIC-F40","amount":"102842693026"},{"denom":"PPC-00A","amount":"205150260"},{"denom":"RBT-CB7","amount":"1008261"},{"denom":"RC1-943","amount":"1826704"},{"denom":"RC1-A1E","amount":"1826704"},{"denom":"RC1-F49","amount":"1826704"},{"denom":"SVC-A14","amount":"18267042"},{"denom":"TC1-F43","amount":"1826704"},{"denom":"TFA-3B4","amount":"5731324"},{"denom":"TGT-9FC","amount":"33251102828"},{"denom":"UCX-CC8","amount":"1398859649"},{"denom":"UDO-638","amount":"5041308481"},{"denom":"USDT.B-B7C","amount":"138793116268"},{"denom":"WWW76-A8F","amount":"4611856"},{"denom":"XSX-072","amount":"10228149"},{"denom":"YLC-D8B","amount":"210572645"},{"denom":"ZEBRA-16D","amount":"1000"},{"denom":"ZZZ-21E","amount":"13988596"}],"public_key":{"type":"tendermint/PubKeySecp256k1","value":"AhOb3ZXecsIqwqKw+HhTscyi6K35xYpKaJx10yYwE0Qa"},"account_number":"406226","sequence":"52"},"name":"","frozen":null,"locked":[{"denom":"BNB","amount":"800"}]}} ``` -You can also query from `/account/`. This is how [go-sdk](https://github.com/binance-chain/go-sdk/blob/master/client/rpc/dex_client.go#L144) handles balance query, because it relects account changes which are not committed in a block too. +You can also query from `/account/`. This is how [go-sdk](https://github.com/bnb-chain/go-sdk/blob/master/client/rpc/dex_client.go#L144) handles balance query, because it relects account changes which are not committed in a block too. ```shell curl 'https://data-seed-pre-0-s3.binance.org/abci_query?path="/account/tbnb1hn8ym9xht925jkncjpf7lhjnax6z8nv2mu9wy3"' diff --git a/docs/beaconchain/develop/bcsdk.md b/docs/beaconchain/develop/bcsdk.md index 43417f0f72..db41ae9270 100644 --- a/docs/beaconchain/develop/bcsdk.md +++ b/docs/beaconchain/develop/bcsdk.md @@ -1,6 +1,6 @@ -# Beacon Chain SDK +# BNB Beacon Chain SDK -Beacon Chain provides SDK in different languages for various purposes. Following is the list of SDKs. +BNB Beacon Chain provides SDK in different languages for various purposes. Following is the list of SDKs. - [GoLang](https://github.com/bnb-chain/go-sdk/wiki) - [Java](https://github.com/bnb-chain/java-sdk/wiki) \ No newline at end of file diff --git a/docs/beaconchain/develop/node/fullnode-faq.md b/docs/beaconchain/develop/node/fullnode-faq.md index e4ee2d5cc9..1e8111f92b 100644 --- a/docs/beaconchain/develop/node/fullnode-faq.md +++ b/docs/beaconchain/develop/node/fullnode-faq.md @@ -102,13 +102,13 @@ Please note that open files are different now. #### Forget to Upgrade -The Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: +The BNB Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: ``` panic: Tendermint state.AppHash does not match AppHash after replay. Got , expected 393887B67F69B19CAB5C48FB87B4966018ABA893FB3FFD241C0A94D2C8668DD2 goroutine 1 [running]: -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) -/Users/huangsuyu/go/src/github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) +/Users/huangsuyu/go/src/github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) ``` To recover from the `state` conflict error, you need to: diff --git a/docs/beaconchain/develop/node/fullnodeissue.md b/docs/beaconchain/develop/node/fullnodeissue.md index 2a1ff3f631..7fdb204c00 100644 --- a/docs/beaconchain/develop/node/fullnodeissue.md +++ b/docs/beaconchain/develop/node/fullnodeissue.md @@ -114,13 +114,13 @@ Please note that open files are different now. #### Forget to Upgrade -The Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: +The BNB Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: ``` panic: Tendermint state.AppHash does not match AppHash after replay. Got , expected 393887B67F69B19CAB5C48FB87B4966018ABA893FB3FFD241C0A94D2C8668DD2 goroutine 1 [running]: -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) -/Users/huangsuyu/go/src/github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) +/Users/huangsuyu/go/src/github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) ``` To recover from the `state` conflict error, you need to: diff --git a/docs/beaconchain/develop/node/install.md b/docs/beaconchain/develop/node/install.md index efb4b910b3..cfb80374cd 100644 --- a/docs/beaconchain/develop/node/install.md +++ b/docs/beaconchain/develop/node/install.md @@ -1,6 +1,6 @@ # Install Binaries -This guide will explain how to install the binaries: `bnbchaind` and `bnbcli`, onto your server. With these installed on a server, you can participate in the mainnet or testnet as a Full Node. Full Nodes of Beacon Chain also help the network by accepting transactions from other nodes and then relaying them to the core BNB Chain network. +This guide will explain how to install the binaries: `bnbchaind` and `bnbcli`, onto your server. With these installed on a server, you can participate in the mainnet or testnet as a Full Node. Full Nodes of BNB Beacon Chain also help the network by accepting transactions from other nodes and then relaying them to the core BNB Chain network. ## Supported Platforms We support running a full node on `Mac OS`, `Windows` and `Linux`. diff --git a/docs/beaconchain/develop/node/join-mainnet.md b/docs/beaconchain/develop/node/join-mainnet.md index 37d0ccc4a5..785271503a 100644 --- a/docs/beaconchain/develop/node/join-mainnet.md +++ b/docs/beaconchain/develop/node/join-mainnet.md @@ -21,7 +21,7 @@ The hardware must meet certain requirements to run a Full Node. ### Sync From Snapshot (Recommended) -1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for Beacon Chain. You can setup this by: +1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for BNB Beacon Chain. You can setup this by: ``` mkdir ~/.bnbchaind @@ -81,7 +81,7 @@ bnbchaind start --home /usr/local/beacon-chain & If you encounter any issue when running a Full Node, you can read the FAQ list [here](fullnodeissue.md). ### Sync From Genesis Block (Not Recommended) -1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for Beacon Chain. You can setup this by: +1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for BNB Beacon Chain. You can setup this by: ``` mkdir ~/.bnbchaind diff --git a/docs/beaconchain/develop/node/join-testnet.md b/docs/beaconchain/develop/node/join-testnet.md index d716150af5..3206c7b9f3 100644 --- a/docs/beaconchain/develop/node/join-testnet.md +++ b/docs/beaconchain/develop/node/join-testnet.md @@ -19,7 +19,7 @@ The hardware must meet certain requirements to run a Full Node. ## Setting Up a New Node -1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for Beacon Chain. You can setup this by: +1. You need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for BNB Beacon Chain. You can setup this by: ``` mkdir ~/.bnbchaind diff --git a/docs/beaconchain/develop/node/nodetypes.md b/docs/beaconchain/develop/node/nodetypes.md index 98aaa09d61..a98c3a09fa 100644 --- a/docs/beaconchain/develop/node/nodetypes.md +++ b/docs/beaconchain/develop/node/nodetypes.md @@ -3,11 +3,11 @@ ## Full Node Node Roles -There are two types of Full Nodes in Beacon Chain network: validator nodes and witness nodes. +There are two types of Full Nodes in BNB Beacon Chain network: validator nodes and witness nodes. ### What is a Validator Node? -Validators are a group/IT infrastructure that take the responsibility to maintain the Beacon Chain data and validate all the transactions. They join the consensus procedure and +Validators are a group/IT infrastructure that take the responsibility to maintain the BNB Beacon Chain data and validate all the transactions. They join the consensus procedure and vote to produce blocks. The fees are collected and distributed among all validators. You can consider Validator as "miner" in Bitcoin and Ethereum and similar concepts exist in dPoS blockchain as EOS or dBFT in NEO. The initial validators are selected from trusted members of the BNB Chain community, and will eventually expand to more members as the BNB Chain blockchain and ecosystem matures, this responsibility will be distributed. The decentralized governance procedure will be introduced and executed. More qualified organization/individual can become Validators. @@ -15,7 +15,7 @@ blockchain as EOS or dBFT in NEO. The initial validators are selected from trust ### What is a Witness Node? -Witness nodes represent the majority of nodes in a Beacon Chain deployment. Although they do not join the consensus process +Witness nodes represent the majority of nodes in a BNB Beacon Chain deployment. Although they do not join the consensus process and produce blocks, they take care of: - The witness consensus process. @@ -42,7 +42,7 @@ To see the existing RPC endpoints provided by witness node, check the list [her ### What is an Accelerated Node? While users can submit transactions and most of the queries via normal, self-run full nodes.
-Accelerated Node provides more secure and faster lines to access Beacon Chain . +Accelerated Node provides more secure and faster lines to access BNB Beacon Chain . Accelerated Node is a special infrastructure built around Validator to facilitate accelerated transaction routing and provide richer, faster user interfaces. There are always several Accelerated Nodes running diff --git a/docs/beaconchain/develop/node/snapshot.md b/docs/beaconchain/develop/node/snapshot.md index 96110afaa1..c855cd6a11 100644 --- a/docs/beaconchain/develop/node/snapshot.md +++ b/docs/beaconchain/develop/node/snapshot.md @@ -1,6 +1,6 @@ # Chain Data Snapshots -A snapshot is a recording of the state of Beacon Chain at a particular block height. +A snapshot is a recording of the state of BNB Beacon Chain at a particular block height. Latest snapshot of April 1st: [download](https://s3.ap-northeast-1.amazonaws.com/dex-bin.bnbstatic.com/s3-witness-data-download/data_20210401.tgz?AWSAccessKeyId=AKIAYINE6SBQPUZDDRRO&Expires=1643611407&Signature=DNHRq9emOD%2FwBLmBSCU9aHt3ENI%3D) @@ -48,7 +48,7 @@ Size: 309 GB sha256sum: c6ba5edbf1b424696eec670f4dad864e09ebbae46c3c127360e1d1f15e27d4df) -This snapshot can be used for jumpstarting a newly setup fullnode to avoid waiting a long time for getting all blocks. In Beacon Chain , the average block time is less than a second. As a result, it will take several weeks to sync from genesis block. +This snapshot can be used for jumpstarting a newly setup fullnode to avoid waiting a long time for getting all blocks. In BNB Beacon Chain , the average block time is less than a second. As a result, it will take several weeks to sync from genesis block. !!! Note diff --git a/docs/beaconchain/develop/node/synctypes.md b/docs/beaconchain/develop/node/synctypes.md index 2c1d8fc79c..9bc51dcaf5 100644 --- a/docs/beaconchain/develop/node/synctypes.md +++ b/docs/beaconchain/develop/node/synctypes.md @@ -20,7 +20,7 @@ Configuration is located in `$BNCHOME/config/config.toml`: The default way to get newly joined Full Node syncing with other Full Node is `state sync`. Once your Full Node is synced to a snapshot, it will switch to `fast-sync` mode to catch up with its peers. -State sync can help fullnode in same status with other peers within short time (according to our test, a one month ~800M DB snapshot in Beacon Chain testnet can be synced in around 45 minutes). As explained in [BEP18](https://github.com/bnb-chain/BEPs/blob/master/BEP18.md), State sync will get the application state of your full node to be up to date without downloading all of the blocks.The sync speed is faster than fast sync. +State sync can help fullnode in same status with other peers within short time (according to our test, a one month ~800M DB snapshot in BNB Beacon Chain testnet can be synced in around 45 minutes). As explained in [BEP18](https://github.com/bnb-chain/BEPs/blob/master/BEP18.md), State sync will get the application state of your full node to be up to date without downloading all of the blocks.The sync speed is faster than fast sync. Now you do not need to allocate more memories to your full node for this feature to work. Configuration is located in `$BNCHOME/config/config.toml`: @@ -54,7 +54,7 @@ Turning off `state_sync_reactor` and `state_sync` can save your memory after you ## Hot Sync -In Beacon Chain network, almost every fullnode operator will first enable `state-sync` to get synced with peers. After downloading all the state machine changes, the fullnode will go back to `fast-sync` mode and eventually in `consensus` mode. In fast-sync mode, the fullnode will have high delay because it needs to be aware of peers’ heights. It downloads all the blocks in parallel and verifying their commits. On the other hand, when a fullnode is under `consensus` state, it will consume a lot of bandwidth and CPU resources because it receives a lot of redundant messages for consensus engine and writes more WAL. To increase the efficiency for fullnodes, the `hot-sync` protocol is introduced. A fullnode under `hot-sync` protocol will pull the blocks from its peers and it will subscribe these blocks in advance. It will skip the message for prevotes and only subscribe to maj23 precommit and block proposal messages. At the same time, it will put its peers in different buckets and subscribe to peers in active buckets. `Hot-Sync` can help fullnodes gossip blocks in low latency, while cost less network, memory, cpu and disk resources than Tendermint consensus protocol. Even cheap hardware can easily run a fullnode, and a fullnode can connect with more peers than before by saving network and CPU resources. +In BNB Beacon Chain network, almost every fullnode operator will first enable `state-sync` to get synced with peers. After downloading all the state machine changes, the fullnode will go back to `fast-sync` mode and eventually in `consensus` mode. In fast-sync mode, the fullnode will have high delay because it needs to be aware of peers’ heights. It downloads all the blocks in parallel and verifying their commits. On the other hand, when a fullnode is under `consensus` state, it will consume a lot of bandwidth and CPU resources because it receives a lot of redundant messages for consensus engine and writes more WAL. To increase the efficiency for fullnodes, the `hot-sync` protocol is introduced. A fullnode under `hot-sync` protocol will pull the blocks from its peers and it will subscribe these blocks in advance. It will skip the message for prevotes and only subscribe to maj23 precommit and block proposal messages. At the same time, it will put its peers in different buckets and subscribe to peers in active buckets. `Hot-Sync` can help fullnodes gossip blocks in low latency, while cost less network, memory, cpu and disk resources than Tendermint consensus protocol. Even cheap hardware can easily run a fullnode, and a fullnode can connect with more peers than before by saving network and CPU resources. The state transition of a hot sync reactor can be of three part: diff --git a/docs/beaconchain/develop/node/upgrade.md b/docs/beaconchain/develop/node/upgrade.md index 1aebc8b8ce..00ec06a2e1 100644 --- a/docs/beaconchain/develop/node/upgrade.md +++ b/docs/beaconchain/develop/node/upgrade.md @@ -4,7 +4,7 @@ Please follow our official channels to get the latest news about upcoming upgrad ## Upgrading Full Node -Many of Beacon Chain upgrades are hardfork ones. If so, you have to finish the upgrade steps before the hardfork block height. +Many of BNB Beacon Chain upgrades are hardfork ones. If so, you have to finish the upgrade steps before the hardfork block height. 1. If your node is already synced with the network, please download the new binary and replace the previous version 2. Replace the config.toml and app.toml under home folder with the latest versions. You can customize those parameters. @@ -15,13 +15,13 @@ bnbchaind start --home ## Forgot to Upgrade -The Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: +The BNB Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: ``` panic: Tendermint state.AppHash does not match AppHash after replay. Got , expected 393887B67F69B19CAB5C48FB87B4966018ABA893FB3FFD241C0A94D2C8668DD2 goroutine 1 [running]: -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) -/Users/huangsuyu/go/src/github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) +/Users/huangsuyu/go/src/github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) ``` To recover from the `state` conflict error, you need to: diff --git a/docs/beaconchain/develop/testnetandexplorer.md b/docs/beaconchain/develop/testnetandexplorer.md index 7087e15ade..617d7e70d3 100644 --- a/docs/beaconchain/develop/testnetandexplorer.md +++ b/docs/beaconchain/develop/testnetandexplorer.md @@ -1,5 +1,5 @@ -# Beacon Chain Testnet +# BNB Beacon Chain Testnet ### What is a Testnet? @@ -26,12 +26,12 @@ You can connect a node to the testnet by downloading the node binary and testnet 2. Get Testnet Fund: https://testnet.binance.org/faucet-smart -3. Transfer From BNB Smart Chain to Beacon Chain +3. Transfer From BNB Smart Chain to BNB Beacon Chain You can use [Binance Extension Wallet](https://docs.bnbchain.org/docs/binance#transfer-testnet-bnb-from-bsc-to-bc) for cross-chain transfer. ### Explorers for Testnet * BNB Smart Chain Explorer - https://testnet.bscscan.com/ -* Beacon Chain Explorer - https://testnet-explorer.binance.org/ +* BNB Beacon Chain Explorer - https://testnet-explorer.binance.org/ diff --git a/docs/beaconchain/encoding.md b/docs/beaconchain/encoding.md index d7345b211b..8986e91ff4 100644 --- a/docs/beaconchain/encoding.md +++ b/docs/beaconchain/encoding.md @@ -1,6 +1,6 @@ -# Beacon Chain Transaction Encoding Specification +# BNB Beacon Chain Transaction Encoding Specification -Beacon Chain transactions are protocol-based data types and can only be submitted in a compatible encoded frame. +BNB Beacon Chain transactions are protocol-based data types and can only be submitted in a compatible encoded frame. The fundamental encoding logic is from [Tendermint Amino](https://github.com/tendermint/go-amino), which derives from and is "largely compatible with" Google protocol-buffer's Proto3. @@ -8,7 +8,7 @@ However the client sides only needs to stick to the specifications outlined belo ## Encoding Output -Beacon Chain (Amino) encoding logic may encode a data structure into two output formats: Binary and JSON. +BNB Beacon Chain (Amino) encoding logic may encode a data structure into two output formats: Binary and JSON. ### JSON Marshal Amino supports JSON encoding natively, which is the same as other usual json marshalers. Except that it can add one more `type` info for registered type, as shown below. @@ -31,9 +31,9 @@ Binary encoding is a variant of Google's protobuf. The bytes are laid out in the - to encode data field of some specific types, an object type prefix for the field will be added ahead of the real encoding. 4. repeated (array) Encoding - it is the same as google protocol buffer, while encoding of the object/struct may contain the type prefix as shown below. -## Beacon Chain Transaction Encoding +## BNB Beacon Chain Transaction Encoding -Below are the data types that can be sent to Beacon Chain as requests, and their encoding layout. To simplify the presentation, we will use a variant of [Google protocol buffer proto3](https://developers.google.com/protocol-buffers/docs/proto3) language to illustrate how the data fields are organized. Except the all-capitalized fields, other fields will use the default `proto3` encoding logic. +Below are the data types that can be sent to BNB Beacon Chain as requests, and their encoding layout. To simplify the presentation, we will use a variant of [Google protocol buffer proto3](https://developers.google.com/protocol-buffers/docs/proto3) language to illustrate how the data fields are organized. Except the all-capitalized fields, other fields will use the default `proto3` encoding logic. ### Standard Transaction @@ -140,7 +140,7 @@ message StdSignature { ``` ### Message Types -Messages represent the individual operations possible on Beacon Chain , and these can be inserted into the `StdTx.msgs` field. Message types are otherwise known as "transaction types", and these terms are used interchangebly in this document and in our technical documentation. So far every `StdTx` transaction "container" can only contain one "message". +Messages represent the individual operations possible on BNB Beacon Chain , and these can be inserted into the `StdTx.msgs` field. Message types are otherwise known as "transaction types", and these terms are used interchangebly in this document and in our technical documentation. So far every `StdTx` transaction "container" can only contain one "message". #### Transfer Transfer is the transaction used for transferring funds to different addresses. @@ -254,7 +254,7 @@ OptionNoWithVeto = 0x04 // no with veto ``` #### Issue -Issue (create) new asset on Beacon Chain . +Issue (create) new asset on BNB Beacon Chain . ```go message IssueTokenValue { 0x17EFAB80 // hardcoded, object type prefix in 4 bytes @@ -387,7 +387,7 @@ message Timerelock{ #### HTLT -Hash Timer Locked Transfer (HTLT) is a new transaction type on Beacon Chain , to serve as HTLC in the first step of Atomic Swap +Hash Timer Locked Transfer (HTLT) is a new transaction type on BNB Beacon Chain , to serve as HTLC in the first step of Atomic Swap ```go message HTLT{ diff --git a/docs/beaconchain/exchange-integration.md b/docs/beaconchain/exchange-integration.md index 23ea802eda..8dad310f02 100644 --- a/docs/beaconchain/exchange-integration.md +++ b/docs/beaconchain/exchange-integration.md @@ -19,13 +19,13 @@ Command Line Interface is currently available for Linux, Mac and Windows.
Please refer to the [CLI Reference](api-reference/cli.md). ## SDKs -There are multiple advanced SDK solutions available for BNB Beacon chain. +There are multiple advanced SDK solutions available for BNB Beacon Chain. Majority of SDKs provide simplified functions to: - Create wallets and manage keys -- Encode/sign transactions and submit to Beacon Chain/DEX, including Transfer, New Order, Cancel Order, etc. -- Communicate with Beacon Chain/DEX via Node RPC calls through public node RPC services or your own private full nodes +- Encode/sign transactions and submit to BNB Beacon Chain/DEX, including Transfer, New Order, Cancel Order, etc. +- Communicate with BNB Beacon Chain/DEX via Node RPC calls through public node RPC services or your own private full nodes List of currently available SDKs and their respective documentations: diff --git a/docs/beaconchain/faq/faq.md b/docs/beaconchain/faq/faq.md index fad06d6bec..6ad7c68959 100644 --- a/docs/beaconchain/faq/faq.md +++ b/docs/beaconchain/faq/faq.md @@ -1,13 +1,13 @@ -# Beacon Chain FAQ +# BNB Beacon Chain FAQ -## What is Beacon Chain, or Binance DEX? +## What is BNB Beacon Chain, or Binance DEX? -Beacon Chain is the blockchain initially developed by Binance and community. Binance DEX, which is disabled now, is the -decentralized exchange module developed on top of the Beacon Chain blockchain. +BNB Beacon Chain is the blockchain initially developed by Binance and community. Binance DEX, which is disabled now, is the +decentralized exchange module developed on top of the BNB Beacon Chain blockchain. -## What is the design principle of Beacon Chain? +## What is the design principle of BNB Beacon Chain? -The main focuses for the design of Beacon Chain are: +The main focuses for the design of BNB Beacon Chain are: - No custody of funds: traders maintain control of their private keys and funds. - High performance: low latency, high throughput for a large user base, and high liquidity trading. @@ -17,7 +17,7 @@ We target to achieve 1 second block times, with 1 confirmation finality. - Fair trading: minimize front-running, to the extent possible. - Evolvable: able to develop with forever-improving technology stack, architecture, and ideas. -## What can you do on Beacon Chain? +## What can you do on BNB Beacon Chain? You can: @@ -25,24 +25,24 @@ You can: - Issue new tokens - Send, receive, burn/mint and freeze/unfreeze tokens -## Will Beacon Chain introduce more features and transaction types in the future? +## Will BNB Beacon Chain introduce more features and transaction types in the future? -Yes, Beacon Chain team and community would cherish the technology advancements and recommended trends and strive to make circulation of assets and value easier and easier. +Yes, BNB Beacon Chain team and community would cherish the technology advancements and recommended trends and strive to make circulation of assets and value easier and easier. -## What is the native coin on Beacon Chain? +## What is the native coin on BNB Beacon Chain? -The Binance Coin, BNB, is the native asset on Beacon Chain. There are 200MM BNB coins in total. +The Binance Coin, BNB, is the native asset on BNB Beacon Chain. There are 200MM BNB coins in total. There will be no mining. The existing coin burns and freezes will still be in effect on the new -Beacon Chain blockchain. +BNB Beacon Chain blockchain. The exact number of BNB coins will be destroyed based on the same number of BNB ERC20 tokens that have already been destroyed. -Since Beacon Chain is live, all BNB ERC20 tokens will be swapped for Beacon Chain coins. All +Since BNB Beacon Chain is live, all BNB ERC20 tokens will be swapped for BNB Beacon Chain coins. All users who hold BNB ERC20 tokens can deposit them to Binance.com, and upon withdrawal, the new -Beacon Chain native coins will be sent to their new wallets. +BNB Beacon Chain native coins will be sent to their new wallets. -## What is the current Fee Table on Beacon Chain Mainnet? +## What is the current Fee Table on BNB Beacon Chain Mainnet? Fees are variable and may change over time as governance proposals are proposed and voted on. The current fees table for **Mainnet** as of **2021-03-21** is as follows: @@ -88,7 +88,7 @@ Smart Chain Proposal Vote | N/A| 0 BNB | N Cross transfer out relayer reward | N/A| 0.0004 BNB | N -## What is the current Fee Table on Beacon Chain Testnet? +## What is the current Fee Table on BNB Beacon Chain Testnet? Fees are variable and may change over time as governance proposals are proposed and voted on. The current fees table for Testnet as of **2021-03-17** is as follows: @@ -137,7 +137,7 @@ Cross transfer out relayer reward | N/A| 0.0004 BNB | N ## Can I see balances of others or can other people see my balances? Yes, anyone can see anyone's balances if they know the corresponding addresses. -Beacon Chain is 100% transparent for transactions and balances. +BNB Beacon Chain is 100% transparent for transactions and balances. ## Information provided through API and their usage @@ -153,17 +153,17 @@ No fee or commission at all (free to use). ## I forgot the private key for my address, how can I get it back? Sorry, you cannot. Owner of the address takes full responsibility for the private key protection. -Beacon Chain and official wallets do not have your private key. +BNB Beacon Chain and official wallets do not have your private key. ## My private key got stolen by hackers, how can I recover my assets? -Sorry, you take full responsibility of your private key ownership and protection. Beacon Chain +Sorry, you take full responsibility of your private key ownership and protection. BNB Beacon Chain and official wallets will not record, or transfer out your private key. ## What is the Accelerated Node? While users can submit transactions and most of the queries via normal, self-run full nodes.
-Accelerated Node provides more secure and faster lines to access Beacon Chain. +Accelerated Node provides more secure and faster lines to access BNB Beacon Chain. Accelerated Node is special infrastructure built around Validator to facilitate accelerated transaction routing and provide richer, faster user interfaces. There are always several Accelerated Nodes running @@ -173,7 +173,7 @@ For rapid API access, you'd better stay with one Accelerated Node to get better ## How can I issue an asset? -Anyone can pay a fee and issue an asset as Token on Beacon Chain, as long as they provide +Anyone can pay a fee and issue an asset as Token on BNB Beacon Chain, as long as they provide proper information for the fields below, and then execute the command through the command line or http interfaces. - Name: a description string of less than 21 characters @@ -181,20 +181,20 @@ proper information for the fields below, and then execute the command through th - Total Supply: a positive number less than or equal to 90 billions - Mint-able: whether the token can increase Total Supply in later time or not -## What is the consensus algorithm used on Beacon Chain? +## What is the consensus algorithm used on BNB Beacon Chain? -Beacon Chain uses BFT and PoS (upcoming) based consensus mechanism to produce blocks among +BNB Beacon Chain uses BFT and PoS (upcoming) based consensus mechanism to produce blocks among a series of qualified Validators. This is similar to the architectures of several existing popular blockchain platforms such as EOS and NEO. -The process for setting up validators among different entities on Beacon Chain is currently being defined. More details will be shared at a later date. +The process for setting up validators among different entities on BNB Beacon Chain is currently being defined. More details will be shared at a later date. -## Can I run a full node for Beacon Chain? +## Can I run a full node for BNB Beacon Chain? -Yes, you can. A full node contains all the information and application logic for Beacon Chain. +Yes, you can. A full node contains all the information and application logic for BNB Beacon Chain. It can receive and broadcast blocks and transactions with other full nodes and even validators. The only exception is it will not participate in the consensus if the full node is not a Validator. -## Does Beacon Chain support Smart Contracts? +## Does BNB Beacon Chain support Smart Contracts? No. This was an intentional design decision to improve the performance of the system and eliminate having to support unnecessary features. @@ -202,22 +202,22 @@ having to support unnecessary features. If you have certain must-have feature-s, it might be added as a native implementation instead of using smart contract.
Feel free to talk to BNB Chain community. -## How can I transfer tokens, such as Bitcoin, from other blockchains onto Beacon Chain? +## How can I transfer tokens, such as Bitcoin, from other blockchains onto BNB Beacon Chain? Right now, there are 2 ways to transfer tokens cross-chain: -1. via interoperability among different chains. After the latest “Archimedes” upgrade, [BEP3](https://github.com/binance-chain/BEPs/blob/master/BEP3.md) was introduced and it defines native transactions to support [Hash Timelock Contract (HTLC)](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) on Beacon Chain and it also to defines the infrastructure standard and procedure to use HTLC for inter-chain [atomic swap](https://www.binance.vision/blockchain/atomic-swaps-explained) to easily swap tokens on different chains. Beacon Chain development community has finished implementing its solution for BEP3 with BEP2 and ERC20 tokens and decided to open-source all of the key components, including： -* [smart-contract solution](https://github.com/binance-chain/bep3-smartcontracts) that supports Atomic Peg Swap (APS) for Ethereum. Please note that this solution is already audited by 3rd party. -* [deputy process](https://github.com/binance-chain/bep3-deputy) written in GoLang that handles swap activities +1. via interoperability among different chains. After the latest “Archimedes” upgrade, [BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md) was introduced and it defines native transactions to support [Hash Timelock Contract (HTLC)](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) on BNB Beacon Chain and it also to defines the infrastructure standard and procedure to use HTLC for inter-chain [atomic swap](https://www.binance.vision/blockchain/atomic-swaps-explained) to easily swap tokens on different chains. BNB Beacon Chain development community has finished implementing its solution for BEP3 with BEP2 and ERC20 tokens and decided to open-source all of the key components, including： +* [smart-contract solution](https://github.com/bnb-chain/bep3-smartcontracts) that supports Atomic Peg Swap (APS) for Ethereum. Please note that this solution is already audited by 3rd party. +* [deputy process](https://github.com/bnb-chain/bep3-deputy) written in GoLang that handles swap activities Any developer is welcome to test the solutions in testnet and then use them in mainnet. -2. via Binance.com. [Binance](https://wwww.binance.com),the largest cryptocurrency exchange, has issued a number of crypto-pegged tokens on Beacon Chain (BEP2 token format): [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), [BEP2 BCH](https://explorer.binance.org/asset/BCH-1FD),[BEP2 XRP](https://explorer.binance.org/asset/XRP-BF2), [BEP2 LTC](https://explorer.binance.org/asset/LTC-F07). Pegged tokens such as [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), are 100% backed by the native coin in [reserve](https://btc.com/3LYJfcfHPXYJreMsASk2jkn69LWEYKzexb). The reserve addresses are published for anyone to audit. Read this [blog](https://www.binance.com/en/blog/347360878904684544/Introducing-BitcoinPegged-Token-on-Binance-Chain) to learn about the reserved address. Users are free to convert between native and BEP2 Bitcoin via deposit/withdrawal. This has a higher degree of ease-of-use for most traders. More swap channels will be provided on partner wallets soon. +2. via Binance.com. [Binance](https://wwww.binance.com),the largest cryptocurrency exchange, has issued a number of crypto-pegged tokens on BNB Beacon Chain (BEP2 token format): [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), [BEP2 BCH](https://explorer.binance.org/asset/BCH-1FD),[BEP2 XRP](https://explorer.binance.org/asset/XRP-BF2), [BEP2 LTC](https://explorer.binance.org/asset/LTC-F07). Pegged tokens such as [BEP2 Bitcoin](https://explorer.binance.org/asset/BTCB-1DE), are 100% backed by the native coin in [reserve](https://btc.com/3LYJfcfHPXYJreMsASk2jkn69LWEYKzexb). The reserve addresses are published for anyone to audit. Read this [blog](https://www.binance.com/en/blog/347360878904684544/Introducing-BitcoinPegged-Token-on-Binance-Chain) to learn about the reserved address. Users are free to convert between native and BEP2 Bitcoin via deposit/withdrawal. This has a higher degree of ease-of-use for most traders. More swap channels will be provided on partner wallets soon. Atomic swap and this centralized approach are not exclusive to other decentralized approaches, which can also be implemented in parallel. There are many cross-chain solutions being developed and we are very interested in them. -Please do __NOT__ try to transfer anything on existing network to Beacon Chain testnet, you may experience loss by doing so, because testnet doesn't run with real coins. +Please do __NOT__ try to transfer anything on existing network to BNB Beacon Chain testnet, you may experience loss by doing so, because testnet doesn't run with real coins. -## How would a third-party integrate with Beacon Chain and Binance DEX? +## How would a third-party integrate with BNB Beacon Chain and Binance DEX? -A wallet provider may choose to support the feature set of Beacon Chain, which would cover wallets, addresses, balances, transfers and etc.
\ No newline at end of file +A wallet provider may choose to support the feature set of BNB Beacon Chain, which would cover wallets, addresses, balances, transfers and etc.
\ No newline at end of file diff --git a/docs/beaconchain/fullnode.md b/docs/beaconchain/fullnode.md index 4b0b7b6fc3..24ffa01e51 100644 --- a/docs/beaconchain/fullnode.md +++ b/docs/beaconchain/fullnode.md @@ -1,6 +1,6 @@ -# Run Full Node to Join Beacon Chain +# Run Full Node to Join BNB Beacon Chain -A `full node` of Beacon Chain is a `witness`, which observes the consensus messaging, downloads blocks from `data seed nodes` and executes business logic to achieve the consistent state as `validator node` (and other `full node`). Full nodes also help the network by accepting transactions from other nodes and then relaying them to the core BNB Chain network. +A `full node` of BNB Beacon Chain is a `witness`, which observes the consensus messaging, downloads blocks from `data seed nodes` and executes business logic to achieve the consistent state as `validator node` (and other `full node`). Full nodes also help the network by accepting transactions from other nodes and then relaying them to the core BNB Chain network. ## Supported Platforms @@ -14,7 +14,7 @@ The hardware must meet certain requirements to run a full node. - 500 GB of free disk space, accessible at a minimum read/write speed of 100 MB/s. - 4 cores of CPU and 8 gigabytes of memory (RAM). - A broadband Internet connection with upload/download speeds of at least 1 megabyte per second -- Your full node has to run at least 4 hours per 24 hours in order to catch up with Beacon Chain +- Your full node has to run at least 4 hours per 24 hours in order to catch up with BNB Beacon Chain More hours will be better, run your node continuously for best results. ## Steps to Run a Full Node @@ -38,7 +38,7 @@ upzip linux_binary.zip ### Initialize Home Folder -First you need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for Beacon Chain .
+First you need to choose a home folder `$BNCHOME` (i.e. ~/.bnbchaind) for BNB Beacon Chain .
You can setup this by: ``` @@ -52,7 +52,7 @@ Put `app.toml`, `config.toml` and `genesis.json` from mainnet_config.zip/testnet ### Add Seed Nodes -For a full node to function, it must connect to one or more known nodes to join Beacon Chain .
+For a full node to function, it must connect to one or more known nodes to join BNB Beacon Chain .
There are several famous `seed nodes` that offer known node addresses in the network to newly joined full nodes.
They are already in `config.toml` file, which sits in mainnet_config.zip/testnet_config.zip. @@ -70,7 +70,7 @@ If you want to add seed nodes, please feel free to edit the field `seeds` of `$B ### Config Syncing -Beacon Chain is making blocks at a very fast pace and its block height is over 60 million. As a result, it will take a long time to **[fast-sync](#fast-sync)** (download all the blocks from genesis block). To decrease the waiting time, an innovative way of syncing a fullnode is introduced and it's called **[state-sync](#state-sync)**. **State Sync** is the default way of syncing in the published config files. If you need to switch to **Fast Sync**, you need to change the `config.toml` accordingly. You can read more in the following sections. +BNB Beacon Chain is making blocks at a very fast pace and its block height is over 60 million. As a result, it will take a long time to **[fast-sync](#fast-sync)** (download all the blocks from genesis block). To decrease the waiting time, an innovative way of syncing a fullnode is introduced and it's called **[state-sync](#state-sync)**. **State Sync** is the default way of syncing in the published config files. If you need to switch to **Fast Sync**, you need to change the `config.toml` accordingly. You can read more in the following sections. #### Additional Configuration @@ -89,7 +89,7 @@ Start the full node according to the place of your executables.
bnbchaind start --home $BNCHOME& ``` -Only after catching up with Beacon Chain , the fullnode can handle requests correctly. +Only after catching up with BNB Beacon Chain , the fullnode can handle requests correctly. #### Details on Sync Mode @@ -126,7 +126,7 @@ Configuration is located in `$BNCHOME/config/config.toml`: * `pong_timeout` Recommendation is set to `450s` * `state_sync_height` Recommendation is set to `0`, so it allows to state sync from the peers's latest height. Please do not change the height to other number, unless you are doing some debug. -State sync can help fullnode in same status with other peers within short time (according to our test, a one month ~800M DB snapshot in Beacon Chain testnet can be synced in around 45 minutes) so that you can receive latest blocks/transactions and query latest status of orderbook, account balances etc.. But state sync DOES NOT download historical blocks before state sync height, if you start your node with state sync and it synced at height 10000, then your local database would only have blocks after height 10000. +State sync can help fullnode in same status with other peers within short time (according to our test, a one month ~800M DB snapshot in BNB Beacon Chain testnet can be synced in around 45 minutes) so that you can receive latest blocks/transactions and query latest status of orderbook, account balances etc.. But state sync DOES NOT download historical blocks before state sync height, if you start your node with state sync and it synced at height 10000, then your local database would only have blocks after height 10000. If full node has already started, suggested way is to delete the (after backup) `$BNCHOME/data` directory and `$BNCHOME/config/priv_validator_key.json` before enabling state sync. @@ -139,7 +139,7 @@ If you turn on the `state_sync_reactor`, the snapshots of heights will be saved > Please note that this feature is still expreimental and is not recommended. -In Beacon Chain network, almost every fullnode operator will first enable `state-sync` to get synced with peers. After downloading all the state machine changes, the fullnode will go back to `fast-sync` mode and eventually in `consensus` mode. In fast-sync mode, the fullnode will have high delay because it needs to be aware of peers’ heights. It downloads all the blocks in parallel and verifying their commits. On the other hand, when a fullnode is under `consensus` state, it will consume a lot of bandwidth and CPU resources because it receives a lot of redundant messages for consensus engine and writes more WAL. +In BNB Beacon Chain network, almost every fullnode operator will first enable `state-sync` to get synced with peers. After downloading all the state machine changes, the fullnode will go back to `fast-sync` mode and eventually in `consensus` mode. In fast-sync mode, the fullnode will have high delay because it needs to be aware of peers’ heights. It downloads all the blocks in parallel and verifying their commits. On the other hand, when a fullnode is under `consensus` state, it will consume a lot of bandwidth and CPU resources because it receives a lot of redundant messages for consensus engine and writes more WAL. To increase the efficiency for fullnodes, the `hot-sync` protocol is introduced. A fullnode under `hot-sync` protocol will pull the blocks from its peers and it will subscribe these blocks in advance. It will skip the message for prevotes and only subscribe to maj23 precommit and block proposal messages. At the same time, it will put its peers in different buckets and subscribe to peers in active buckets. `Hot-Sync` can help fullnodes gossip blocks in low latency, while cost less network, memory, cpu and disk resources than Tendermint consensus protocol. Even cheap hardware can easily run a fullnode, and a fullnode can connect with more peers than before by saving network and CPU resources. The state transition of a hot sync reactor can be of three part: diff --git a/docs/beaconchain/fullnodeissue.md b/docs/beaconchain/fullnodeissue.md index 93a91fbfa5..b8f2d42b33 100644 --- a/docs/beaconchain/fullnodeissue.md +++ b/docs/beaconchain/fullnodeissue.md @@ -118,9 +118,9 @@ The BNB Chain has a hardfork upgrade and if you failed to upgrade your fullnode ``` panic: Tendermint state.AppHash does not match AppHash after replay. Got , expected 393887B67F69B19CAB5C48FB87B4966018ABA893FB3FFD241C0A94D2C8668DD2 goroutine 1 [running]: -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) -/Users/huangsuyu/go/src/github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 -github.com/binance-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.checkAppHash(0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, 0x20, ...) +/Users/huangsuyu/go/src/github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus/replay.go:464 +0x213 +github.com/bnb-chain/node/vendor/github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(0xc000b37980, 0xa, 0x0, 0xc000bd8c56, 0x6, 0xc000b247c0, 0x12, 0x14e7bf9, 0x8592eb, 0xc000b247e0, ...) ``` To recover from the `state` conflict error, you need to: diff --git a/docs/beaconchain/get-started.md b/docs/beaconchain/get-started.md index fadc7a7868..7f6f3eb031 100644 --- a/docs/beaconchain/get-started.md +++ b/docs/beaconchain/get-started.md @@ -1,8 +1,8 @@ -# Get Started with Beacon Chain +# Get Started with BNB Beacon Chain ## Wallet -The easiest way to use Beacon Chain is through a wallet with support for Beacon Chain accounts and transfers. +The easiest way to use BNB Beacon Chain is through a wallet with support for BNB Beacon Chain accounts and transfers. For example, Binance provides a Web Wallet at [https://www.binance.org](https://www.binance.org)
Binance also provides Web Wallet for testnet at [https://testnet.binance.org](https://testnet.binance.org)
@@ -12,13 +12,13 @@ Both provide the functions below: - Showing the balances of assets on the addresses - Sending and receiving assets -Beacon Chain Web Wallet also presents a trading UI where you can examine market data and manage your orders to trade among the listed assets. +BNB Beacon Chain Web Wallet also presents a trading UI where you can examine market data and manage your orders to trade among the listed assets. Learn about the list of wallet available [here](wallets.md). ## Chain Explorer Chain Explorer provides a portal to explore blocks and transaction details.
-On Beacon Chain Explorer, you can also check different asset types, the distribution of their ownerships, and owners' transactions. +On BNB Beacon Chain Explorer, you can also check different asset types, the distribution of their ownerships, and owners' transactions. ## REST API There are [Accelerated Nodes](faq/faq.md#what-is-the-accelerated-node) which provide advanced API services for the public.
@@ -45,12 +45,12 @@ Please refer to the [CLI Reference](../api-reference/cli.md). ### Use SDKs SDKs are also provided as a starting point for your apps.
-There are two advanced SDK solutions for Beacon Chain : [Java]() and [Golang]().
+There are two advanced SDK solutions for BNB Beacon Chain : [Java]() and [Golang]().
Both solutions provide functions for:
* Create wallets and manage keys -* Encode/sign transactions and submit to Beacon Chain /DEX, including Transfer, New Order, Cancel Order, etc. -* Communicate with Beacon Chain /DEX Node RPC calls through public node RPC services or your own private full nodes +* Encode/sign transactions and submit to BNB Beacon Chain /DEX, including Transfer, New Order, Cancel Order, etc. +* Communicate with BNB Beacon Chain /DEX Node RPC calls through public node RPC services or your own private full nodes Please refer to specific SDK documentation for more information: diff --git a/docs/beaconchain/governance.md b/docs/beaconchain/governance.md index 8dd3bf046b..80bf73956b 100644 --- a/docs/beaconchain/governance.md +++ b/docs/beaconchain/governance.md @@ -2,8 +2,8 @@ ## Introduction -Beacon Chain has its own built-in module that lets BNB holders submit proposals for governance. -There are several kinds of proposals can be submitted to Beacon Chain for different purposes: 1) text proposals for signaling, 2) fee paramter change proposals, 3) list and delist proposals (which are no longer supported), and 4) [side chain proposals](https://docs.bnbchain.org/docs/learn/bsc-gov/#introduction). +BNB Beacon Chain has its own built-in module that lets BNB holders submit proposals for governance. +There are several kinds of proposals can be submitted to BNB Beacon Chain for different purposes: 1) text proposals for signaling, 2) fee paramter change proposals, 3) list and delist proposals (which are no longer supported), and 4) [side chain proposals](https://docs.bnbchain.org/docs/learn/bsc-gov/#introduction). In order for the proposal to be open for voting, it needs to come with a deposit that is greater than a parameter called `Deposit`. The deposit does not need to be provided entirety by the submitter. If the initial proposer's deposit is not sufficient, the proposal enters the deposit period. Then, any BNB holder can increase the deposit by sending a deposit transaction. @@ -41,7 +41,7 @@ Please refer to [this](https://docs.bnbchain.org/docs/learn/bsc-gov/#workflow) f | **parameter name** | **example** | **comments** | **required** | |--------------------|--------------------------------------------|-------------------------------------------------------------------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --status | passed | filter proposals by proposal status, status: deposit_period/voting_period/passed/rejected | No | | --voter | bnb1h9ymecpakr8p8lhchtah2xxx7x4xq099umclqu | filter by proposals voted on by voted | No | @@ -58,7 +58,7 @@ Please refer to [this](https://docs.bnbchain.org/docs/learn/bsc-gov/#workflow) f | **parameter name** | **example** | **comments** | **required** | |--------------------|-------------------|--------------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | ```bash @@ -85,7 +85,7 @@ $ ./bnbcli gov query-proposal --chain-id Binance-Chain-Tigris --node https://dat | **parameter name** | **example** | **comments** | **required** | |--------------------|-------------------|------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | No | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | No | ```bash ## mainnet @@ -102,7 +102,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |:---------------------|:------------------|:--------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | | --title | "list" | title of proposal | Yes | @@ -130,7 +130,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |:---------------------|:------------------|:--------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | | --title | "list" | title of proposal | Yes | @@ -152,7 +152,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |:-------------------|:----------------------|:--------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | | --title | "test csc change" | title of proposal | Yes | @@ -171,7 +171,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |--------------------|-------------------|----------------------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | | --option | Yes | vote option {yes, no, no_with_veto, abstain} | Yes | @@ -188,7 +188,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |--------------------|-------------------|--------------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | | --deposit | Yes | amount of deposit | Yes | @@ -205,7 +205,7 @@ Note: this kind of proposal is not supported on mainnet and testnnet now. | **parameter name** | **example** | **comments** | **required** | |--------------------|-------------------|--------------------------------------|--------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | ```bash diff --git a/docs/beaconchain/index.md b/docs/beaconchain/index.md index e93d5d1c72..c9cf647ecc 100644 --- a/docs/beaconchain/index.md +++ b/docs/beaconchain/index.md @@ -1,34 +1,34 @@ -# Beacon Chain Documentation +# BNB Beacon Chain Documentation -Welcome to the Beacon Chain documentation site! +Welcome to the BNB Beacon Chain documentation site! -Please note that both the Beacon Chain software and this documentation site will improve over time and is still a work-in-progress.
+Please note that both the BNB Beacon Chain software and this documentation site will improve over time and is still a work-in-progress.
Be sure to engage with our community channels to stay updated. Have fun trading and see you on chain! -## What are Beacon Chain and Binance DEX? +## What are BNB Beacon Chain and Binance DEX? -[Beacon Chain](https://www.bnbchain.org) is a blockchain software system developed by its community. -Binance DEX refers to the decentralized exchange features developed on top of Beacon Chain. +[BNB Beacon Chain](https://www.bnbchain.org) is a blockchain software system developed by its community. +Binance DEX refers to the decentralized exchange features developed on top of BNB Beacon Chain. Please read the [FAQ](faq/faq.md) to get started. ## What is BNB Smart Chain? -[BNB Smart Chain](https://www.bnbchain.org/en/smartChain) is an innovative solution to bring programmability and interoperability to Beacon Chain . BNB Smart Chain relies on a system of [41 validators with Proof of Staked Authority (PoSA)](https://https://github.com/bnb-chain/whitepaper/blob/master/WHITEPAPER.md) consensus that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. +[BNB Smart Chain](https://www.bnbchain.org/en/smartChain) is an innovative solution to bring programmability and interoperability to BNB Beacon Chain . BNB Smart Chain relies on a system of [41 validators with Proof of Staked Authority (PoSA)](https://https://github.com/bnb-chain/whitepaper/blob/master/WHITEPAPER.md) consensus that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. Please read the [FAQ](../BSC-FAQs-general.md) to get started. -## What can I do with Beacon Chain ? +## What can I do with BNB Beacon Chain ? The purpose of the new blockchain and DEX is to create an alternative marketplace for issuing and exchanging digital assets in a decentralized manner. You can: - [Send and receive BNB](transfer.md#web-wallet) -- [Issue new tokens to digitalize assets](https://community.binance.org/topic/2487), and use Beacon Chain as underlying exchange/transfer +- [Issue new tokens to digitalize assets](https://community.binance.org/topic/2487), and use BNB Beacon Chain as underlying exchange/transfer network for the assets - Send, receive, [burn](tokens.md#burn)/[mint](tokens.md#mint) and [freeze/unfreeze](tokens.md#freeze-unfreeze) tokens - [Sumbit an on-chain governance proposal for BNB Smart Chain ](learn/bsc-gov.md) @@ -42,15 +42,15 @@ network for the assets **For developers**, you can also: -- Explore the transaction history and blocks on the chain, via [Beacon Chain Explore](https://explorer.binance.org), [API](develop/api-reference/dex-api/paths.md) +- Explore the transaction history and blocks on the chain, via [BNB Beacon Chain Explore](https://explorer.binance.org), [API](develop/api-reference/dex-api/paths.md) and [node RPC](develop/api-reference/node-rpc.md) interfaces. - Run a [full node](fullnode.md) to listen to and broadcast live updates on transactions, blocks, and consensus activities -- Extract other data of Beacon Chain via full node or [APIs](develop/api-reference/dex-api/paths.md#apiv1markets) -- [Develop tools](exchange-integration.md#sdks) and application to help users use Beacon Chain and Binance DEX +- Extract other data of BNB Beacon Chain via full node or [APIs](develop/api-reference/dex-api/paths.md#apiv1markets) +- [Develop tools](exchange-integration.md#sdks) and application to help users use BNB Beacon Chain and Binance DEX ## What can I do with BNB Smart Chain ? -BNB Smart Chain (BSC) is best described as a blockchain that runs in parallel to the Beacon Chain . Unlike Beacon Chain , BSC boasts smart contract functionality and compatibility with the Ethereum Virtual Machine (EVM). The design goal here was to leave the high throughput of Beacon Chain intact while introducing smart contracts into its ecosystem. +BNB Smart Chain (BSC) is best described as a blockchain that runs in parallel to the BNB Beacon Chain . Unlike BNB Beacon Chain , BSC boasts smart contract functionality and compatibility with the Ethereum Virtual Machine (EVM). The design goal here was to leave the high throughput of BNB Beacon Chain intact while introducing smart contracts into its ecosystem. Because BSC is EVM-compatible, it launched with support for the rich universe of [Ethereum](https://academy.binance.com/en/articles/what-is-ethereum) tools and DApps. In theory, this makes it easy for developers to port their projects over from Ethereum. For users, it means that applications like [MetaMask](../wallet/metamask.md) can be easily configured to work with BSC. Seriously – it’s just a matter of tweaking a couple of settings. Check out [Use MetaMask for BNB Smart Chain ](../wallet/metamask.md) to get started. @@ -64,23 +64,23 @@ and node RPC interfaces. **Developers** can also: - [Issue](../issue-BEP20.md) new tokens to digitalize assets -- [Migrate](https://github.com/binance-chain/bsc-develop-ecosystem) existing DApps +- [Migrate](https://github.com/bnb-chain/bsc-develop-ecosystem) existing DApps - Run a [full node](fullnode.md) to listen to and broadcast live updates on transactions, blocks, and consensus activities - [Develop wallets](../wallet/wallet_api.md) and tools to help users use Dapps ## Comparision Between BC and BSC -| | Beacon Chain | BNB Smart Chain | +| | BNB Beacon Chain | BNB Smart Chain | | ----------------- | ------------- | -------------------------------------- | | Consensus | DPoS | PoSA | | No. of Validators | 11 | up to 50 | | Mean Block Time | <1s | ~5s | | Programmability | BEPs | Support EVM-compatible smart contracts | -| Cross Chain |[BEP3](https://github.com/binance-chain/BEPs/blob/master/BEP3.md) introduces *Hash Timer Locked Contract functions* and further [mechanism](https://community.binance.org/topic/1892) to handle inter-blockchain tokens peg. | BSC comes with efficient [native dual chain communication](../learn/cross-chain.md); Optimized for scaling high-performance dApps that require fast and smooth user experience. | +| Cross Chain |[BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md) introduces *Hash Timer Locked Contract functions* and further [mechanism](https://community.binance.org/topic/1892) to handle inter-blockchain tokens peg. | BSC comes with efficient [native dual chain communication](../learn/cross-chain.md); Optimized for scaling high-performance dApps that require fast and smooth user experience. | ## Get Started -Want to try it **Beacon Chain **? Just give a peek at the first few of pages of the [getting started guide](get-started.md).
+Want to try it **BNB Beacon Chain **? Just give a peek at the first few of pages of the [getting started guide](get-started.md).
You could also have a read through the [FAQ](faq/faq.md). Want to develop on **BNB Smart Chain **? First, read through the [FAQ](../BSC-FAQs-general.md) and learn about tokens [here](../BEP20.md). @@ -89,24 +89,24 @@ Want to develop on **BNB Smart Chain **? First, read through the [FAQ](../BSC-FA ### BEP2 Asset -Beacon Chain is essentially a digital asset creation and exchange platform.
-The features listed below are currently supported on Beacon Chain : +BNB Beacon Chain is essentially a digital asset creation and exchange platform.
+The features listed below are currently supported on BNB Beacon Chain : - [The Issuance, Burning, Minting and Freezing of Tokens](tokens.md) - [Transfer of Tokens](transfer.md) ### BEP20 Asset -A token protocol on BSC which is compatible with BEP2 and [ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 and contains more interfaces, such as `getOwner` and `decimals`. Read the full proposal here: +A token protocol on BSC which is compatible with BEP2 and [ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 and contains more interfaces, such as `getOwner` and `decimals`. Read the full proposal here: - [Issue BEP20](../issue-BEP20.md) - [Wallet](../Wallet.md) ## BNB (and Other Coins) MainNet Switch -Build N Build Coin (BNB) was an ERC20 token on the Ethereum network. After the launch of Beacon Chain, Build N Build Coin (BNB) is being converted into native BNB tokens on the main network via the exchange platform at [binance.com](https://www.binance.com), a pragmatic and efficient way to perform the initial token swap. +Build N Build Coin (BNB) was an ERC20 token on the Ethereum network. After the launch of BNB Beacon Chain, Build N Build Coin (BNB) is being converted into native BNB tokens on the main network via the exchange platform at [binance.com](https://www.binance.com), a pragmatic and efficient way to perform the initial token swap. -Beacon Chain is ready for other projects to migrate their tokens to take advantage of performant transactions with more liquidity options and native marketplace features.
+BNB Beacon Chain is ready for other projects to migrate their tokens to take advantage of performant transactions with more liquidity options and native marketplace features.
More information about how projects can set themselves up for this (via [binance.com](https://www.binance.com) or partners) will come soon. ## BNB Staking @@ -115,7 +115,7 @@ Please read the guide [here](../wallet/staking.md) ## Trading on Binance DEX -Binance DEX is the native marketplace on Beacon Chain , allowing you to exchange digital assets issued and listed on it.
+Binance DEX is the native marketplace on BNB Beacon Chain , allowing you to exchange digital assets issued and listed on it.
The matching happens within the blockchain nodes and all of the transactions are recorded on-chain, therefore forming a complete, auditable ledger of activity. **ATTENTION**: The match logic on DEX is quite different from normal centralized exchange.
@@ -128,11 +128,11 @@ Please go over the trading and match spec below to get the best interests for yo ## Technology Details Continue reading below if you are interested in what is happening under the hood! -- [Beacon Chain as a Block Chain](blockchain.md): about consensus, software stack, network layout and roles. -- [Connect to Beacon Chain ](chain-access.md): how to connect to Beacon Chain and DEX via different ways. -- [Run a Beacon Chain full node](fullnode.md): how to run a full node and become part of the p2p network of Beacon Chain . -- [Run a Beacon Chain light client](light-client.md): how to run a light client. -- [Beacon Chain Governance](governance.md): about proposal, vote, and join as a validator. +- [BNB Beacon Chain as a Block Chain](blockchain.md): about consensus, software stack, network layout and roles. +- [Connect to BNB Beacon Chain ](chain-access.md): how to connect to BNB Beacon Chain and DEX via different ways. +- [Run a BNB Beacon Chain full node](fullnode.md): how to run a full node and become part of the p2p network of BNB Beacon Chain . +- [Run a BNB Beacon Chain light client](light-client.md): how to run a light client. +- [BNB Beacon Chain Governance](governance.md): about proposal, vote, and join as a validator. ## Acknowledgement Thanks to the [community, our partners and supporters](acknowledgement.md). diff --git a/docs/beaconchain/learn/BEP82.md b/docs/beaconchain/learn/BEP82.md index f4fc6077fa..c16414f667 100644 --- a/docs/beaconchain/learn/BEP82.md +++ b/docs/beaconchain/learn/BEP82.md @@ -4,9 +4,9 @@ ## Introduction -Before implementing BEP82, many token-related transactions, such as token listing, minting, burning, can only be proposed by the token owner. The owner of any BEP2/BEP8 token can not be changed once the token is issued on Beacon Chain . +Before implementing BEP82, many token-related transactions, such as token listing, minting, burning, can only be proposed by the token owner. The owner of any BEP2/BEP8 token can not be changed once the token is issued on BNB Beacon Chain . -BEP82 introduced the changes related to the token owner who issued a token on Beacon Chain . It provides more convenience and flexibility for these transactions. +BEP82 introduced the changes related to the token owner who issued a token on BNB Beacon Chain . It provides more convenience and flexibility for these transactions. ## Status diff --git a/docs/beaconchain/learn/accounts.md b/docs/beaconchain/learn/accounts.md index 6356cac911..2bdab8f51f 100644 --- a/docs/beaconchain/learn/accounts.md +++ b/docs/beaconchain/learn/accounts.md @@ -32,7 +32,7 @@ After Account is created, besides the balances, Account also contains: - Account Number: an internal identifier for the account - Sequence Number: an ever-changing integer. -The `Sequence Number` is the way how Beacon Chain prevents Replay Attack (the idea is borrowed from Cosmos network, but varies a bit in handling). Every transaction should have a new Sequence Number increased by 1 from the current latest sequence number of the Account, and after this transaction is recorded on the blockchain, the Sequence Number will be set to the same number as the one of latest transaction. +The `Sequence Number` is the way how BNB Beacon Chain prevents Replay Attack (the idea is borrowed from Cosmos network, but varies a bit in handling). Every transaction should have a new Sequence Number increased by 1 from the current latest sequence number of the Account, and after this transaction is recorded on the blockchain, the Sequence Number will be set to the same number as the one of latest transaction. This logic forces the client to be aware of the current Sequence Number, either by reading from the blockchain via API, or keep the counting locally by themselves. The recommended way is to keep counting locally and re-synchronize from the blockchain periodically. @@ -45,11 +45,11 @@ This default wallet would use a similar way to generate keys as Bitcoin, i.e. us ### Keys -Beacon Chain uses the same elliptic curve cryptography as the current [Bitcoin implementation](https://github.com/btcsuite/btcd/tree/master/btcec), i.e. `secp256k1`. Its private key is 32 bytes while public key is 33 bytes. +BNB Beacon Chain uses the same elliptic curve cryptography as the current [Bitcoin implementation](https://github.com/btcsuite/btcd/tree/master/btcec), i.e. `secp256k1`. Its private key is 32 bytes while public key is 33 bytes. ### Address -Addresses on Beacon Chain are 20 bytes and may be expressed as: +Addresses on BNB Beacon Chain are 20 bytes and may be expressed as: ``` Address = RIPEMD160(SHA256(compressed public key)) @@ -57,7 +57,7 @@ Address = RIPEMD160(SHA256(compressed public key)) Typically, an address is encoded in the [bech32](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) format which includes a checksum and human-readable prefix (HRP). However, it doesn't use the `SegWit` address format (because we do not have `SegWit` function anyway, so no `witness program version` etc.). -A Beacon Chain address is therefore more similar to a [Bitcoin Cash address](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md), which does not include a SegWit program script. +A BNB Beacon Chain address is therefore more similar to a [Bitcoin Cash address](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md), which does not include a SegWit program script. Address format pseudo-code: @@ -65,8 +65,8 @@ Address format pseudo-code: Address_Bech32 = HRP + '1' + bech32.encode(convert8BitsTo5Bits(RIPEMD160(SHA256(compressed public key)))) ``` -For Beacon Chain address, the prefix is `bnb` for production network, and `tbnb` for testnet. +For BNB Beacon Chain address, the prefix is `bnb` for production network, and `tbnb` for testnet. ### Signature -Beacon Chain uses an ECDSA signature on curve secp256k1 against a `SHA256` hash of the byte array of a JSON-encoded canonical representation of the transaction. For more information, please see [this page](encoding/encoding.md#canonical-bytes-for-signing). +BNB Beacon Chain uses an ECDSA signature on curve secp256k1 against a `SHA256` hash of the byte array of a JSON-encoded canonical representation of the transaction. For more information, please see [this page](encoding/encoding.md#canonical-bytes-for-signing). diff --git a/docs/beaconchain/learn/architecture.md b/docs/beaconchain/learn/architecture.md index dd9db6e64e..e47f77003a 100644 --- a/docs/beaconchain/learn/architecture.md +++ b/docs/beaconchain/learn/architecture.md @@ -2,7 +2,7 @@ BNB Beacon Chain is a multi-modular blockchain with excellent native support for account management, asset management, cross chain, goverenance and so on. It is esay to extend to support different initiatives of BNB ecosystem. -Beacon Chain uses [Tendermint](https://github.com/tendermint/tendermint) BFT consensus, and a dedicated application layer, which is built with Cosmos SDK, runs upon it. +BNB Beacon Chain uses [Tendermint](https://github.com/tendermint/tendermint) BFT consensus, and a dedicated application layer, which is built with Cosmos SDK, runs upon it. A simplified overview of the application's architecture might look something like this: ``` @@ -36,16 +36,16 @@ Here are the main moudles: - Asset - A fruitful set of features are implemented for asset management, for example, users can issue, mint/burn, freeze/unfreeze, lock/unlock BEP2 and BEP8 tokens. -- Governance - Beacon Chain supports on-chain governance of beacon chain and side chains. Holders of the native token (i.e., BNB) can submit proposals and vote on proposals to apply different kinds of changes on chains. +- Governance - BNB Beacon Chain supports on-chain governance of BNB Beacon Chain and side chains. Holders of the native token (i.e., BNB) can submit proposals and vote on proposals to apply different kinds of changes on chains. -- Staking - With this moudle, BNB holders can become validators and can delegate tokens to validators, ultimately determining the effective validator sets for beacon chain and side chains (e.g., BSC). +- Staking - With this moudle, BNB holders can become validators and can delegate tokens to validators, ultimately determining the effective validator sets for BNB Beacon Chain and side chains (e.g., BSC). -- Distribution - Beacon Chain will actively distribute rewards between validators and delegators, for both Beacon Chain itself and its side chains. +- Distribution - BNB Beacon Chain will actively distribute rewards between validators and delegators, for both BNB Beacon Chain itself and its side chains. -- Cross Chain - Beacon Chain supports the cross chain transfers of native tokens. Cross chain communication is also built in, to support different kinds of usage scenarios. +- Cross Chain - BNB Beacon Chain supports the cross chain transfers of native tokens. Cross chain communication is also built in, to support different kinds of usage scenarios. - Slashing - Slashing module will disincentivize any bad actor by penalizing them. -- Params - A globally available parameter store is provided by Beacon Chain. These parameters affects the excution of Beacon Chain itself and its side chains, and can be changed by goverenance. +- Params - A globally available parameter store is provided by BNB Beacon Chain. These parameters affects the excution of BNB Beacon Chain itself and its side chains, and can be changed by goverenance. - APIs - RPC, HTTP, and Websocket APIs are provided for interacting with blockchains and the related services. Developers can use these APIs to build their Web3 applications, wallets, data services and so on. \ No newline at end of file diff --git a/docs/beaconchain/learn/assets.md b/docs/beaconchain/learn/assets.md index f2329372b9..85a669bef7 100644 --- a/docs/beaconchain/learn/assets.md +++ b/docs/beaconchain/learn/assets.md @@ -1,6 +1,6 @@ # Assets -Assets are stored as `tokens` on Beacon Chain , and the below management actions are available. All the assets are complied with [BEP2 standard](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). [BEP](https://github.com/bnb-chain/BEPs/blob/master/BEP1.md) stands for BNB Chain Evolution Proposal. Each BEP will be a proposal document providing information to the Beacon Chain /DEX community. The BEP should provide a concise technical specification of the feature or improvement and the rationale behind it. Each BEP proposer is responsible for building consensus within the community and documenting dissenting opinions. Each BEP has a unique index number. +Assets are stored as `tokens` on BNB Beacon Chain , and the below management actions are available. All the assets are complied with [BEP2 standard](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). [BEP](https://github.com/bnb-chain/BEPs/blob/master/BEP1.md) stands for BNB Chain Evolution Proposal. Each BEP will be a proposal document providing information to the BNB Beacon Chain /DEX community. The BEP should provide a concise technical specification of the feature or improvement and the rationale behind it. Each BEP proposer is responsible for building consensus within the community and documenting dissenting opinions. Each BEP has a unique index number. ## BEP2 Token Properties @@ -22,16 +22,16 @@ Explanations: Suffix is the first 3 bytes of the issue transaction’s hash, for ### Issue Process: -1. Issuer signed an issue transaction and broadcast it to one of Beacon Chain nodes -2. This Beacon Chain node will check this transaction. If there is no error, then this transaction will be broadcasted to other Beacon Chain nodes +1. Issuer signed an issue transaction and broadcast it to one of BNB Beacon Chain nodes +2. This BNB Beacon Chain node will check this transaction. If there is no error, then this transaction will be broadcasted to other BNB Beacon Chain nodes 3. Issue transaction is committed on the blockchain by block proposer 4. Validators will verify the constraints on total supply and symbol and deduct the fee from issuer’s account -5. New token’s symbol is generated based on the transaction hash. It is added to the issuer’s address and token info is saved on the Beacon Chain +5. New token’s symbol is generated based on the transaction hash. It is added to the issuer’s address and token info is saved on the BNB Beacon Chain ## BNB -The Build N Build Coin, `BNB`, is the native asset on Beacon Chain . There are 200MM BNB coins in total. There will be no mining. The existing coin burns and freezes will still be in effect on the new Beacon Chain blockchain. +The Build N Build Coin, `BNB`, is the native asset on BNB Beacon Chain . There are 200MM BNB coins in total. There will be no mining. The existing coin burns and freezes will still be in effect on the new BNB Beacon Chain blockchain. The exact number of BNB coins will be destroyed based on the same number of BNB ERC20 tokens that have already been destroyed. -Since Beacon Chain is live, all BNB ERC20 tokens will be swapped for Beacon Chain coins. All users who hold BNB ERC20 tokens can deposit them to Binance.com, and upon withdrawal, the new Beacon Chain native coins will be sent to their new wallets. +Since BNB Beacon Chain is live, all BNB ERC20 tokens will be swapped for BNB Beacon Chain coins. All users who hold BNB ERC20 tokens can deposit them to Binance.com, and upon withdrawal, the new BNB Beacon Chain native coins will be sent to their new wallets. diff --git a/docs/beaconchain/learn/atomic-swaps.md b/docs/beaconchain/learn/atomic-swaps.md index fc9243b7c8..59bd0e945e 100644 --- a/docs/beaconchain/learn/atomic-swaps.md +++ b/docs/beaconchain/learn/atomic-swaps.md @@ -10,14 +10,14 @@ Atomic swaps can be used for trading between BEP2 tokens, or for trading across ## Hash Timer Locked Contract -[HTLC](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) has been used for Atomic Swap and cross payment channel for a few years on Bitcoin and its variant blockchains, and also Ethereum. This BEP defines native transactions to support HTLC on Beacon Chain , and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token, which is called `Atomic Peg`. +[HTLC](https://en.bitcoin.it/wiki/Hash_Time_Locked_Contracts) has been used for Atomic Swap and cross payment channel for a few years on Bitcoin and its variant blockchains, and also Ethereum. This BEP defines native transactions to support HTLC on BNB Beacon Chain , and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token, which is called `Atomic Peg`. -## HTLC on Beacon Chain +## HTLC on BNB Beacon Chain -As explained in [BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md), Hash Timer Locked Contract(HTLC) has been used for Atomic Swap and cross payment channels between different blockchains. BEP3 defines native transactions to support HTLC on Beacon Chain and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token. +As explained in [BEP3](https://github.com/bnb-chain/BEPs/blob/master/BEP3.md), Hash Timer Locked Contract(HTLC) has been used for Atomic Swap and cross payment channels between different blockchains. BEP3 defines native transactions to support HTLC on BNB Beacon Chain and also proposes the standard infrastructure and procedure to use HTLC for inter-chain atomic swap to easily create and use pegged token. During the swap process, the related fund will be locked to a purely-code-controlled escrow account. -A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in Beacon Chain protocol. This kind of account has no its own private key and it's only controled by code in protocol. The code for calculating escrow account is the same as how it's done in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): +A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in BNB Beacon Chain protocol. This kind of account has no its own private key and it's only controled by code in protocol. The code for calculating escrow account is the same as how it's done in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): ``` AtomicSwapCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("BinanceChainAtomicSwapCoins"))) ``` @@ -26,7 +26,7 @@ The account for mainnet is: **bnb1wxeplyw7x8aahy93w96yhwm7xcq3ke4f8ge93u** and t ### Hash Timer Locked Transfer -Hash Timer Locked Transfer (HTLT) is a new transaction type on Beacon Chain , to serve as HTLC in the first step of Atomic Swap, +Hash Timer Locked Transfer (HTLT) is a new transaction type on BNB Beacon Chain , to serve as HTLC in the first step of Atomic Swap, #### Parameters @@ -109,9 +109,9 @@ Data:[77 137 139 200 85 141 170 77 129 116 134 215 169 59 119 178 200 47 206 194 swapID: 4d898bc8558daa4d817486d7a93b77b2c82fcec2123abf4a1eb7d2521237eccd ``` -2. Swap from Beacon Chain to Ethereum +2. Swap from BNB Beacon Chain to Ethereum -* Clients send HTLT on Beacon Chain on *testnet*: +* Clients send HTLT on BNB Beacon Chain on *testnet*: Command line: ```shell @@ -138,11 +138,11 @@ Javascript: const res = client.swap.HTLT(from, recipient, recipientOtherChain, "", randomNumberHash, timestamp, amount, expectedIncome, heightSpan, true) ``` -3. Swap from Ethereum to Beacon Chain +3. Swap from Ethereum to BNB Beacon Chain > Note: Once cross-chain is true, --recipient-other-chain must not be empty -* Deputy send HTLT on Beacon Chain on *testnet*: +* Deputy send HTLT on BNB Beacon Chain on *testnet*: Command line: ```shell @@ -413,9 +413,9 @@ refundHTLT | N/A | 0.000375 BNB | Y * ERC20 contract has been deployed here: * Token Symbol: **PPC** * SmartContract has been deployed here: -* Its corresponding address on testnet is: `tbnb1pk45lc2k7lmf0pnfa59l0uhwrvpk8shsema7gr`on Beacon Chain and `0xD93395B2771914E1679155F3EA58C41d89D96098` on Ethereum testnet +* Its corresponding address on testnet is: `tbnb1pk45lc2k7lmf0pnfa59l0uhwrvpk8shsema7gr`on BNB Beacon Chain and `0xD93395B2771914E1679155F3EA58C41d89D96098` on Ethereum testnet -### Swap Tokens from Ethereum to Beacon Chain +### Swap Tokens from Ethereum to BNB Beacon Chain ![image-20190918193751444](../../assets/eth2bnc.png) #### 1. Approve Swap Transaction @@ -446,12 +446,12 @@ Go to [smartcontract](https://ropsten.etherscan.io/address/0xd93395b2771914e1679 Example of `htlt` [transaction](https://ropsten.etherscan.io/tx/0xa2444cc1e52e09027ec68bf8955e7084235255f9f18d9b837a12fd63e6f0145c) -#### 3. Deputy Call HTLT on Beacon Chain +#### 3. Deputy Call HTLT on BNB Beacon Chain Then, Deputy will send `HTLT` transaction [here](https://testnet-explorer.binance.org/tx/99CBC2896F0CF14DDAB0684BDA0A3E9FF2271056E68EC3559AB7FB24E0EE97DE) -#### 4. Claim HTLT on Beacon Chain +#### 4. Claim HTLT on BNB Beacon Chain -* Get the `swapID` on Beacon Chain +* Get the `swapID` on BNB Beacon Chain ``` ./tbnbcli token query-swapIDs-by-recipient --recipient-addr tbnb1cs0j4p0p6d3fvd77zg3qzlwwgmrv3e9e63423w --chain-id Binance-Chain-Ganges --trust-node --node http://data-seed-pre-0-s3.binance.org:80 @@ -502,7 +502,7 @@ You can also get swapID by [calculateSwapID in javascript-sdk](https://github.co - `out_amount` should be reasonable. Please note that the decimals of bep2 tokens is 8, the out_amount should be something around 10000000000:PPC, deputy will deduct some fees. - `expire_height` must not be passed and should be enough for send claim transaction -* Send claim transaction on Beacon Chain +* Send claim transaction on BNB Beacon Chain ``` ./tbnbcli token claim --swap-id 12aacc3bdc2cef97e8e45cc9b409796df57904a4e9c76863ad8420ff75f13128 --random-number --from --chain-id Binance-Chain-Ganges --trust-node --node http://data-seed-pre-0-s3.binance.org:80 @@ -594,7 +594,7 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten await wait(20000) //---------------------------------------------------------------------------- - //Step3 query swap created by deputy on Beacon Chain and verify swap parameters + //Step3 query swap created by deputy on BNB Beacon Chain and verify swap parameters //---------------------------------------------------------------------------- const swapID = calculateSwapID(randomNumberHash.replace("0x", ""), deputyBNBWalletAddr, clientEthWalletAddr).toString() console.log(swapID) @@ -614,7 +614,7 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten expect(Number(atomicSwap.result.expireHeight)).toBeGreaterThan(Number(status.sync_info.latest_block_height)+100) //---------------------------------------------------------------------------- - //Step4 claim on Beacon Chain + //Step4 claim on BNB Beacon Chain //---------------------------------------------------------------------------- const res = await bnbClient.swap.claimHTLT(clientBnbWalletAddr, swapID, randomNumber) console.log(res) @@ -624,10 +624,10 @@ This is a javascript implementation for client app to swap [PPC](https://ropsten //---------------------------------------------------------------------------- ``` -### Swap Tokens from Beacon Chain to Ethereum +### Swap Tokens from BNB Beacon Chain to Ethereum ![image-20190918193910521](../../assets/bnc2eth.png) -#### 1. Send `HTLT` Transaction from Beacon Chain +#### 1. Send `HTLT` Transaction from BNB Beacon Chain Please read this [section](#hash-timer-locked-transfer) to generate a valid `HTLT` transaction. Please write down the `randomNumber` and `randomNumberHash`. @@ -675,9 +675,9 @@ You should see that **Deputy** has already approved enough tokens and In its [event log](https://ropsten.etherscan.io/tx/0x142fb8db7eb66feb241ca710a028678e36595fc8aea03858672288fcac8e4494#eventlog), you should see the `swapID`. Before calling `claim` function on ethereum, clients should verify the parameters in the `HTLT` event. -- `_randomNumberHash` must equal to the randomNumberHash in client HTLT transaction on Beacon Chain +- `_randomNumberHash` must equal to the randomNumberHash in client HTLT transaction on BNB Beacon Chain - `_recipientAddr` must equal to client ethereum wallet address -- `_timestamp` must equal to the timestamp in client HTLT transaction on Beacon Chain +- `_timestamp` must equal to the timestamp in client HTLT transaction on BNB Beacon Chain - `_outAmount` should be reasonable. Please note that the decimals erc20 contract and deputy will deduct some fees. - `_expireHeight` must not be passed and should be enough for send claim transaction @@ -690,7 +690,7 @@ Then, you can call the `claim` function: Example is [here](https://ropsten.etherscan.io/tx/0x9cf7cc7891b86987c4eef59e3b4950324d656e6937a38b91786894f52c76f41b) -#### 5. Deputy Claim on Beacon Chain +#### 5. Deputy Claim on BNB Beacon Chain `Claim HTLT` transaction from **Deputy** is [sent](https://testnet-explorer.binance.org/tx/8C616DEFD2EAA41E13D2DC4844B218DFF8CFE24B4C7A693AAD700381B5FF7B48) afterwards: @@ -723,7 +723,7 @@ This is a javascript implementation for client app to swap [PPC-00A](https://te const swapContract = new web3.eth.Contract([{"constant":true,"inputs":[],"name":"ERC20ContractAddr","outputs":[{"name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"isSwapExist","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"refund","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_swapSender","type":"address"},{"name":"_bep2SenderAddr","type":"bytes20"}],"name":"calSwapID","outputs":[{"name":"","type":"bytes32"}],"payable":false,"stateMutability":"pure","type":"function"},{"constant":false,"inputs":[{"name":"_swapID","type":"bytes32"},{"name":"_randomNumber","type":"bytes32"}],"name":"claim","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_timestamp","type":"uint64"},{"name":"_heightSpan","type":"uint256"},{"name":"_recipientAddr","type":"address"},{"name":"_bep2SenderAddr","type":"bytes20"},{"name":"_bep2RecipientAddr","type":"bytes20"},{"name":"_outAmount","type":"uint256"},{"name":"_bep2Amount","type":"uint256"}],"name":"htlt","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"claimable","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"refundable","outputs":[{"name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"name":"_swapID","type":"bytes32"}],"name":"queryOpenSwap","outputs":[{"name":"_randomNumberHash","type":"bytes32"},{"name":"_timestamp","type":"uint64"},{"name":"_expireHeight","type":"uint256"},{"name":"_outAmount","type":"uint256"},{"name":"_sender","type":"address"},{"name":"_recipient","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"inputs":[{"name":"_erc20Contract","type":"address"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"},{"indexed":false,"name":"_timestamp","type":"uint64"},{"indexed":false,"name":"_bep2Addr","type":"bytes20"},{"indexed":false,"name":"_expireHeight","type":"uint256"},{"indexed":false,"name":"_outAmount","type":"uint256"},{"indexed":false,"name":"_bep2Amount","type":"uint256"}],"name":"HTLT","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"}],"name":"Refunded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_msgSender","type":"address"},{"indexed":true,"name":"_recipientAddr","type":"address"},{"indexed":true,"name":"_swapID","type":"bytes32"},{"indexed":false,"name":"_randomNumberHash","type":"bytes32"},{"indexed":false,"name":"_randomNumber","type":"bytes32"}],"name":"Claimed","type":"event"}], swapContractAddr) //-------------------------------------------- - //Step1 send htlt on Beacon Chain + //Step1 send htlt on BNB Beacon Chain //-------------------------------------------- const randomNumber = "e8eae926261ab77d018202434791a335249b470246a7b02e28c3b2fb6ffad8f3" const timestamp = Math.floor(Date.now()/1000) @@ -782,7 +782,7 @@ This is a javascript implementation for client app to swap [PPC-00A](https://te await wait(20000) //---------------------------------------------------------------------------- - //If step2 or step3 are failed and the expire height on Beacon Chain is passed, try to send refundHTLT transaction on Beacon Chain + //If step2 or step3 are failed and the expire height on BNB Beacon Chain is passed, try to send refundHTLT transaction on BNB Beacon Chain //---------------------------------------------------------------------------- ``` diff --git a/docs/beaconchain/learn/bc-bridge.md b/docs/beaconchain/learn/bc-bridge.md index 783c789290..8c987e7338 100644 --- a/docs/beaconchain/learn/bc-bridge.md +++ b/docs/beaconchain/learn/bc-bridge.md @@ -1,13 +1,13 @@ # BC <-> BSC Token Bridge !!! Note - Please note that *BC <-> BSC Token Bridge* is a module of Beacon Chain fullnode to facilitate cross-chain transfer between Beacon Chain and BNB Smart Chain , while [Binance Bridge](https://www.binance.org/en/bridge), a bridge service providing access to inter-blockchain liquidity for Beacon Chain , BNB Smart Chain decentralized applications, and bring valuable assets to Beacon Chain ecosystems. + Please note that *BC <-> BSC Token Bridge* is a module of BNB Beacon Chain fullnode to facilitate cross-chain transfer between BNB Beacon Chain and BNB Smart Chain , while [Binance Bridge](https://www.binance.org/en/bridge), a bridge service providing access to inter-blockchain liquidity for BNB Beacon Chain , BNB Smart Chain decentralized applications, and bring valuable assets to BNB Beacon Chain ecosystems. ## What is BC <-> BSC bridge BC <-> BSC token bridge for self transfers of BEP2 tokens to BEP20 (ERC20 representation). The BC <-> BSC bridge connects two chains (BC and BSC). When a user deposits BEP2 into the BC <-> BSC bridge contract contract on BC they get the same amount of BEP20 tokens on BSC, and they can convert them back as well. -A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code in protocol. The code for calculating escrow account is the same as how it's done in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): +A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in BNB Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code in protocol. The code for calculating escrow account is the same as how it's done in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): ``` AtomicSwapCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("BinanceChainPegAccount"))) ``` @@ -28,7 +28,7 @@ Transfer Out Relayer Fee| 0.01 | ### Download -Please download `tbnbcli` binary from [here](https://github.com/binance-chain/node/releases/tag/v0.8.1) +Please download `tbnbcli` binary from [here](https://github.com/bnb-chain/node/releases/tag/v0.8.1) ### Bind diff --git a/docs/beaconchain/learn/bc-slashing.md b/docs/beaconchain/learn/bc-slashing.md index eccade821e..feb8b1c842 100644 --- a/docs/beaconchain/learn/bc-slashing.md +++ b/docs/beaconchain/learn/bc-slashing.md @@ -39,7 +39,7 @@ If a validator missed more than 50 blocks in 24h, the blocking reward for valida ## Unjail The malicious validators who are slashed by the previous cases will be set to `jailed` along with a duration setting as well due to the malicious or negative behaviors. We can set it to ‘unjailed’ by sending a side-unjail transaction if the validation passed. -When your validator is `unjailed` on beacon chain, it must wait for the next UTC 0:00 to join validatorsest again. +When your validator is `unjailed` on BNB Beacon Chain, it must wait for the next UTC 0:00 to join validatorsest again. ### Transaction Validation * validator address must not be empty @@ -163,7 +163,7 @@ bnbcli slashing side-slash-histories 0x625448c3f21AB4636bBCef84Baaf8D6cCdE13c3F | **parameter name** | **example** | **comments** | **required** | | ------------------ | ----------------- | ---------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | BSC-XXX | chain-id of the side chain the validator belongs to | Yes | #### For example diff --git a/docs/beaconchain/learn/bc-staking.md b/docs/beaconchain/learn/bc-staking.md index d7395c9c48..6bcef26fb9 100644 --- a/docs/beaconchain/learn/bc-staking.md +++ b/docs/beaconchain/learn/bc-staking.md @@ -2,13 +2,13 @@ ## PoSA Consensus of BNB Smart Chain -[BNB Smart Chain ](https://community.binance.org/topic/2686) is an innovative solution to bring programmability and interoperability to [Beacon Chain ](https://www.binance.org). BNB Smart Chain relies on a system of 50 validators with Proof of [Staked Authority (PoSA) consensus](../../beaconchain/learn/genesis.md) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. +[BNB Smart Chain ](https://community.binance.org/topic/2686) is an innovative solution to bring programmability and interoperability to [BNB Beacon Chain ](https://www.binance.org). BNB Smart Chain relies on a system of 50 validators with Proof of [Staked Authority (PoSA) consensus](../../beaconchain/learn/genesis.md) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. -## Staking on Beacon Chain +## Staking on BNB Beacon Chain -Ideally, BNB Smart Chain should build such staking and reward logic into the blockchain, and automatically distribute rewards as the blocking happens. [Cosmos Hub](https://hub.cosmos.network/), who also build on top of Tendermint consensus like Beacon Chain , works in this way. +Ideally, BNB Smart Chain should build such staking and reward logic into the blockchain, and automatically distribute rewards as the blocking happens. [Cosmos Hub](https://hub.cosmos.network/), who also build on top of Tendermint consensus like BNB Beacon Chain , works in this way. -However, as BSC wants to remain compatible with Ethereum as much as possible. On the other side, Beacon Chain already has a staking module and could be extended to support both BC and BSC. In this way, all the staking related operations are recorded in BC. Once there are any changes about BSC's validator set or voting power, the new message will be transferred to BSC through cross-chain communication. +However, as BSC wants to remain compatible with Ethereum as much as possible. On the other side, BNB Beacon Chain already has a staking module and could be extended to support both BC and BSC. In this way, all the staking related operations are recorded in BC. Once there are any changes about BSC's validator set or voting power, the new message will be transferred to BSC through cross-chain communication. ## Staking Economics @@ -119,7 +119,7 @@ Some address parameters we need to highlight here: | ValidatorAddr | validator operator’s address, used in governance ops like voting. | | SideConsAddr | block producer’s address on side chain, i.e. consensus address. BC has another parameter named `PubKey`, here SideConsAddr replaced that for BSC. Only BSC validators need this parameter. | | SideVoteAddr | A bls public key. It's used by validators to vote for blocks, so the BSC chain can finalize blocks within two block periods in normal.| -| SideFeeAddr | fees are collected in this address on BSC, Only BSC validators need this parameter. Due to different token units, there are some BNB left as dust when sending block rewards from BNB Smart Chain to Beacon Chain . Those BNB will be sent to fee address.| +| SideFeeAddr | fees are collected in this address on BSC, Only BSC validators need this parameter. Due to different token units, there are some BNB left as dust when sending block rewards from BNB Smart Chain to BNB Beacon Chain . Those BNB will be sent to fee address.| @@ -389,7 +389,7 @@ bnbcli staking side-unbonding-delegation [delegator-addr] [operator-addr] [flags | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -410,7 +410,7 @@ bnbcli staking side-unbonding-delegations [delegator-addr] [flags] | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -431,7 +431,7 @@ bnbcli staking side-val-unbonding-delegation [operator-addr] [flags] | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -451,7 +451,7 @@ bnbcli staking side-redelegation [delegator-addr] [src-operator-addr] [dst-opera | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -472,7 +472,7 @@ bnbcli staking side-redelegations [delegator-addr] [flags] | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -491,7 +491,7 @@ bnbcli staking side-val-redelegations [operator-addr] [flags] ``` | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | **For example** @@ -507,7 +507,7 @@ bnbcli staking side-val-redelegations bva12hlquylu78cjylk5zshxpdj6hf3t0tahqmr98n | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | @@ -524,7 +524,7 @@ bnbcli staking side-pool --side-chain-id=bsc --chain-id=Binance-Chain-Tigris | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | ------------------------------------------------------------ | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | | --top | 10 | number of validators to be returned. set as maximum number of validators by default | Option | @@ -540,7 +540,7 @@ bnbcli staking side-top-validators --top 10 --side-chain-id=bsc --chain-id=Binan | **parameter name** | **example** | **comments** | **required** | | ------------------- | ----------------- | ------------------------------------------------------------ | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | | --jail-involved | true | if true, meaning that the jailed validators will be involved to count | Option | diff --git a/docs/beaconchain/learn/breathe-block.md b/docs/beaconchain/learn/breathe-block.md index 43e38c4d31..a3edba72d7 100644 --- a/docs/beaconchain/learn/breathe-block.md +++ b/docs/beaconchain/learn/breathe-block.md @@ -12,7 +12,7 @@ There are several approaches to find breathe blocks: - Messages (e.g., kafka messages) can be published to receive breathe blocks, for more information please refer to [breathe block](https://docs.bnbchain.org/docs/beaconchain/get-extra-data-from-fullnode/#11-breatheblock). -- You can also find breathe blocks by accessing local logs if you are running a Beacon Chain node. In `node.log` log file, the heights of breathe blocks will be logged. +- You can also find breathe blocks by accessing local logs if you are running a BNB Beacon Chain node. In `node.log` log file, the heights of breathe blocks will be logged. - Another option is using [Explorer](https://explorer.bnbchain.org/) by looking at the block time. Please do check the surrounding blocks if you find a potential one (multiple blocks can be mined in the same second). @@ -21,7 +21,7 @@ There are several approaches to find breathe blocks: Breathe blocks can execute any logics as normal blocks. Besides, there are some logics only happened in breathe blocks, to unify some handlings or avoid any burden on normal blocks (e.g., for performance). -- Validator set update - In breathe blocks, validator set updates will take effect, i.e., updating validators on beacon chain or triggering cross chain communication for side chain's validator set update. +- Validator set update - In breathe blocks, validator set updates will take effect, i.e., updating validators on BNB Beacon Chain or triggering cross chain communication for side chain's validator set update. - Staking reward calculation and allocation - the staking rewards will be calculated and allocated in breathe blocks. diff --git a/docs/beaconchain/learn/encoding/amino-example.md b/docs/beaconchain/learn/encoding/amino-example.md index f0ebfdf012..824327e3ba 100644 --- a/docs/beaconchain/learn/encoding/amino-example.md +++ b/docs/beaconchain/learn/encoding/amino-example.md @@ -2,7 +2,7 @@ ## Encoding Output -Beacon Chain (Amino) encoding logic may encode a data structure into two output formats: Binary and JSON. +BNB Beacon Chain (Amino) encoding logic may encode a data structure into two output formats: Binary and JSON. ### JSON Marshal Amino supports JSON encoding natively, which is the same as other usual json marshalers. Except that it can add one more `type` info for registered type, as shown below. @@ -16,7 +16,7 @@ Amino supports JSON encoding natively, which is the same as other usual json mar ### Examples in Go-SDK -Let's take a look at an [example function](https://github.com/bnb-chain/go-sdk/blob/fe7524098533a6ce6077cf5f28f677329963d17b/client/rpc/dex_client.go#L373) of Beacon Chain go-sdk. +Let's take a look at an [example function](https://github.com/bnb-chain/go-sdk/blob/fe7524098533a6ce6077cf5f28f677329963d17b/client/rpc/dex_client.go#L373) of BNB Beacon Chain go-sdk. ```golang func (c *HTTP) GetProposal(proposalId int64) (types.Proposal, error) { @@ -64,7 +64,7 @@ Binary encoding is a variant of Google protocol buffer. The bytes are layed out ### Examples in Go-SDK -Let's take a look at an example function of Beacon Chain go-sdk. The signed transaction needs to be amino-encoded, thus ready to be posted to BncChain API. +Let's take a look at an example function of BNB Beacon Chain go-sdk. The signed transaction needs to be amino-encoded, thus ready to be posted to BncChain API. ```golang rawBz, err := c.keyManager.Sign(*signMsg) @@ -85,9 +85,9 @@ rawBz, err := c.keyManager.Sign(*signMsg) ``` -## Beacon Chain Transaction Encoding +## BNB Beacon Chain Transaction Encoding -Below are the data types that can be sent to Beacon Chain as requests, and their encoding layout. To simplify the presentation, we will use a variant of [Google protocol buffer proto3](https://developers.google.com/protocol-buffers/docs/proto3) language to illustrate how the data fields are organized. Except the all-capitalized fields, other fields will use the default `proto3` encoding logic. +Below are the data types that can be sent to BNB Beacon Chain as requests, and their encoding layout. To simplify the presentation, we will use a variant of [Google protocol buffer proto3](https://developers.google.com/protocol-buffers/docs/proto3) language to illustrate how the data fields are organized. Except the all-capitalized fields, other fields will use the default `proto3` encoding logic. ### Standard Transaction @@ -194,7 +194,7 @@ message StdSignature { ``` ### Message Types -Messages represent the individual operations possible on Beacon Chain , and these can be inserted into `StdTx.msgs` field. Message types are otherwise known as "transaction types", and these terms are used interchangeably in this document and in our technical documentation. So far every `StdTx` transaction "container" can only contain one "message". +Messages represent the individual operations possible on BNB Beacon Chain , and these can be inserted into `StdTx.msgs` field. Message types are otherwise known as "transaction types", and these terms are used interchangeably in this document and in our technical documentation. So far every `StdTx` transaction "container" can only contain one "message". #### Transfer Transfer is the transaction for transferring funds to different addresses. @@ -268,7 +268,7 @@ OptionNoWithVeto = 0x04 // no with veto ``` #### Issue -Issue (create) new asset on Beacon Chain . +Issue (create) new asset on BNB Beacon Chain . ```go message IssueTokenValue { 0x17EFAB80 // hardcoded, object type prefix in 4 bytes @@ -388,7 +388,7 @@ message Timerelock{ #### HTLT -Hash Timer Locked Transfer (HTLT) is a new transaction type on Beacon Chain , to serve as HTLC in the first step of Atomic Swap +Hash Timer Locked Transfer (HTLT) is a new transaction type on BNB Beacon Chain , to serve as HTLC in the first step of Atomic Swap ```go message HTLT{ diff --git a/docs/beaconchain/learn/encoding/encoding.md b/docs/beaconchain/learn/encoding/encoding.md index 12d4ea50e6..bc613c6aa1 100644 --- a/docs/beaconchain/learn/encoding/encoding.md +++ b/docs/beaconchain/learn/encoding/encoding.md @@ -6,7 +6,7 @@ hide_table_of_contents: false # Encoding -The Cosmos SDK utilizes two binary wire encoding protocols, [Beacon Chain Amino](https://github.com/bnb-chain/bnc-go-amino) +The Cosmos SDK utilizes two binary wire encoding protocols, [BNB Beacon Chain Amino](https://github.com/bnb-chain/bnc-go-amino) and [Protocol Buffers](https://developers.google.com/protocol-buffers), where Amino is an object encoding specification. It is a subset of Proto3 with an extension for interface support. See the [Proto3 spec](https://developers.google.com/protocol-buffers/docs/proto3) for more information on Proto3, which Amino is largely compatible with (but not with Proto2). diff --git a/docs/beaconchain/learn/escrow-accounts.md b/docs/beaconchain/learn/escrow-accounts.md index 1156470b05..f208a5072b 100644 --- a/docs/beaconchain/learn/escrow-accounts.md +++ b/docs/beaconchain/learn/escrow-accounts.md @@ -1,5 +1,5 @@ # Escrow Accounts -A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in cosmos-sdk. +A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in BNB Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in cosmos-sdk. ## Addresses of Escrow Accounts diff --git a/docs/beaconchain/learn/genesis.md b/docs/beaconchain/learn/genesis.md index a6a9dea72a..748a9e623a 100644 --- a/docs/beaconchain/learn/genesis.md +++ b/docs/beaconchain/learn/genesis.md @@ -41,7 +41,7 @@ version of the software. ### Consensus Parameters Next, the genesis file defines consensus parameters. Consensus parameters regroup all the parameters that are related to -the consensus layer, which is `Tendermint` in the case of `Beacon Chain`. Let us look at these parameters: +the consensus layer, which is `Tendermint` in the case of `BNB Beacon Chain`. Let us look at these parameters: - `block_size` - `max_bytes`: Maximum number of bytes per block is 1048576. @@ -107,7 +107,7 @@ You can see the three different address of all **11** validators. Let us break d #### Token -The `tokens` module handles tokens, which contains the information of Beacon Chain native token `BNB`. +The `tokens` module handles tokens, which contains the information of BNB Beacon Chain native token `BNB`. ```json "tokens": [ diff --git a/docs/beaconchain/learn/matching-engine.md b/docs/beaconchain/learn/matching-engine.md index a0c1ed1629..30bf5aff1d 100644 --- a/docs/beaconchain/learn/matching-engine.md +++ b/docs/beaconchain/learn/matching-engine.md @@ -3,7 +3,7 @@ id: matching-engine title: Matching Engine --- -Binance DEX is the native marketplace on Beacon Chain , allowing you to exchange digital assets issued and listed on it. +Binance DEX is the native marketplace on BNB Beacon Chain , allowing you to exchange digital assets issued and listed on it. The matching happens within the blockchain nodes and all of the transactions are recorded on-chain, therefore forming a complete, auditable ledger of activity. > ATTENTION: The match logic on DEX is quite different from normal centralized exchange. diff --git a/docs/beaconchain/learn/signature.md b/docs/beaconchain/learn/signature.md index 88641e60f8..9b8f3ab46e 100644 --- a/docs/beaconchain/learn/signature.md +++ b/docs/beaconchain/learn/signature.md @@ -4,7 +4,7 @@ Signature is the evidence to prove the sender owns the transaction. It will be c 1. Compose a data structure. please note `msgs`, `memo`, `source`, `data` are the same as in the above `payload`. - - `chain_id`: a string, unique ID for the Chain, it stays the same for most time, but may vary as Beacon Chain evolves; + - `chain_id`: a string, unique ID for the Chain, it stays the same for most time, but may vary as BNB Beacon Chain evolves; - `account_number`: a string for a 64-bit integer, an identifier number associated with the signing address - `sequence`: a string for a a 64-bit integer, please check [accounts](accounts.md) - `memo`: a string, a short sentence of remark for the transaction @@ -34,4 +34,4 @@ type StdSignMsg struct { 3. Sign SHA256 of the encoded byte array, to create an ECDSA signature on curve Secp256k1 and serialize the `R` and `S` result into a 64-byte array. (both `R` and `S` are encoded into 32-byte big endian integers, and then `R` is put into the first 32 bytes and `S` are put into the last 32 bytes of the byte array. In order to break `S` 's malleability, `S` set to `curve.Order() - S` if `S > curnve.Order()/2`.) -The `signature` will be encoded together with transaction message and sent as `payload` to Beacon Chain node via RPC or http REST API, as described in the above section. +The `signature` will be encoded together with transaction message and sent as `payload` to BNB Beacon Chain node via RPC or http REST API, as described in the above section. diff --git a/docs/beaconchain/learn/threshold-signature-scheme.md b/docs/beaconchain/learn/threshold-signature-scheme.md index 9901cd17b7..832bbd244c 100644 --- a/docs/beaconchain/learn/threshold-signature-scheme.md +++ b/docs/beaconchain/learn/threshold-signature-scheme.md @@ -11,20 +11,20 @@ Traditional **MultiSig (multi-signature)** is a more refined unlocking system th With **Threshold Signatures**, all of the parties must forge the vault’s lock together, in a modular way, where each party owns a share of the key. A TSS vault is indistinguishable from a regular vault and is hence universal, and it has the same privacy and verification cost of a regular vault. Even if only a subset of the keys is available, the vault may still be unlocked (this is known as meeting a threshold of participation). -Combining TSS feature with Beacon Chain client will help users manage their funds in a much safer way. TSS will be offered in an independent binary, but it will have some impact on the existing functions of *bnbcli/tbnbcli*. +Combining TSS feature with BNB Beacon Chain client will help users manage their funds in a much safer way. TSS will be offered in an independent binary, but it will have some impact on the existing functions of *bnbcli/tbnbcli*. ## Implementation -Many development resources have been poured into implementing TSS, a cryptographic protocol for distributed key generation and signing. TSS is now compatible and reusable for ECDSA-based blockchains, including Beacon Chain , Bitcoin, and Ethereum networks. We expect that members of the BNB Chain ecosystem and partner community can integrate this TSS library with their applications, such as wallets and custodians, and further develop this exciting new technology. +Many development resources have been poured into implementing TSS, a cryptographic protocol for distributed key generation and signing. TSS is now compatible and reusable for ECDSA-based blockchains, including BNB Beacon Chain , Bitcoin, and Ethereum networks. We expect that members of the BNB Chain ecosystem and partner community can integrate this TSS library with their applications, such as wallets and custodians, and further develop this exciting new technology. -With the support of the Beacon Chain community, we are happy to share the open-source code at https://github.com/bnb-chain/tss-lib. +With the support of the BNB Beacon Chain community, we are happy to share the open-source code at https://github.com/bnb-chain/tss-lib. ## Security Audit The implementation of a multi-party threshold ECDSA [library](https://github.com/bnb-chain/tss-lib) is open source so it can be publicly audited by anyone. An independent third party auditors from [Kudelski Security](https://www.kudelskisecurity.com/) are hired to validate the security of the cryptography in TSS solution. The latest report in October by can be found [here](../../assets/audit-binance-tss-lib-final.pdf). -Security checks are routinely and continuously planed for all parts of TSS lib implmentations and future audits will be reported to Beacon Chain community. +Security checks are routinely and continuously planed for all parts of TSS lib implmentations and future audits will be reported to BNB Beacon Chain community. ## Workflow Let’s take a look at the major steps in TSS: @@ -35,14 +35,14 @@ Let’s take a look at the major steps in TSS: * **Signing**: this step involves a signature generation function. The input of each party will be its own secret share, created as output of the distributed key generation in the previous step. There is also public input known to all, which is the message to be signed. The output will be a digital signature, and the property of privacy ensures that no leakage of secret shares occurred during the computation. -* **Verification**: the verification algorithm remains as it is in the classical setting. To be compatible with single key signatures, Beacon Chain validator nodes can be able to verify the signature with the public key. The transaction will be no different from others. +* **Verification**: the verification algorithm remains as it is in the classical setting. To be compatible with single key signatures, BNB Beacon Chain validator nodes can be able to verify the signature with the public key. The transaction will be no different from others. * **Vault Regroup**: Regroup will reset secret share and configs between all parties.It's recommend to switch the configuration periodically, say once a month. If some party lost his key, it's also necessory to reset the distribution once some party lost their key. Regroup will generate new_n secret share with new_t threshold. At least old_t + 1 should participant ## Where can I download the Binance TSS CLI? -You can download tss client and Beacon Chain Commandline here: +You can download tss client and BNB Beacon Chain Commandline here: * Mainnet: * Testnet: diff --git a/docs/beaconchain/learn/trading-specification.md b/docs/beaconchain/learn/trading-specification.md index fb814f05fe..decfc24a3a 100644 --- a/docs/beaconchain/learn/trading-specification.md +++ b/docs/beaconchain/learn/trading-specification.md @@ -3,6 +3,6 @@ id: trading-specification title: Trading Specification --- -- [ ] https://docs.binance.org/trading-spec.html -- [ ] https://docs.binance.org/match.html -- [ ] https://docs.binance.org/anti-frontrun.html +- [ ] https://docs.bnbchain.org/trading-spec.html +- [ ] https://docs.bnbchain.org/match.html +- [ ] https://docs.bnbchain.org/anti-frontrun.html diff --git a/docs/beaconchain/learn/transaction.md b/docs/beaconchain/learn/transaction.md index 7394c20b80..f6e5aea34a 100644 --- a/docs/beaconchain/learn/transaction.md +++ b/docs/beaconchain/learn/transaction.md @@ -3,7 +3,7 @@ sidebar_label: Transactions hide_table_of_contents: false --- -# Beacon Chain Transaction Basics +# BNB Beacon Chain Transaction Basics A blockchain is a globally shared, transactional database. This means that everyone can read entries in the database just by participating in the network. If you want to change something in the database, you have to create a so-called transaction which has to be accepted by all others. The word transaction implies that the change you want to make (assume you want to change two values at the same time) is either not done at all or completely applied. Furthermore, while your transaction is being applied to the database, no other transaction can alter it. diff --git a/docs/beaconchain/learn/transactions.md b/docs/beaconchain/learn/transactions.md index 7394c20b80..f6e5aea34a 100644 --- a/docs/beaconchain/learn/transactions.md +++ b/docs/beaconchain/learn/transactions.md @@ -3,7 +3,7 @@ sidebar_label: Transactions hide_table_of_contents: false --- -# Beacon Chain Transaction Basics +# BNB Beacon Chain Transaction Basics A blockchain is a globally shared, transactional database. This means that everyone can read entries in the database just by participating in the network. If you want to change something in the database, you have to create a so-called transaction which has to be accepted by all others. The word transaction implies that the change you want to make (assume you want to change two values at the same time) is either not done at all or completely applied. Furthermore, while your transaction is being applied to the database, no other transaction can alter it. diff --git a/docs/beaconchain/learn/walletconnect.md b/docs/beaconchain/learn/walletconnect.md index d762bf7d35..d04ce60dde 100644 --- a/docs/beaconchain/learn/walletconnect.md +++ b/docs/beaconchain/learn/walletconnect.md @@ -3,7 +3,7 @@ id: walletconnect title: Wallet Connect --- -- [ ] https://docs.binance.org/walletconnect.html +- [ ] https://docs.bnbchain.org/walletconnect.html ## What is WalletConnect? WalletConnect is an open protocol for connecting desktop Dapps to mobile Wallets using end-to-end encryption by scanning a QR code. Opening up a whole world of Dapps that were once only available to Metamask. The user can interact with any Dapp without comprising their private keys and will be notified to sign any transaction requests on their mobile. @@ -11,9 +11,9 @@ WalletConnect is an open protocol for connecting desktop Dapps to mobile Wallets ## How does it work? WalletConnect is a simple infrastructure that can be setup by any developer. Using a Bridge server to relay the messages without having access to any of its contents. The contents are encrypted using the session data shared by the QR code between the desktop and mobile. There are libraries for Web, iOS and Android. Read more about it in our documentation introduction. -## Wallets with WalletConnect Support for Beacon Chain +## Wallets with WalletConnect Support for BNB Beacon Chain -* List of Wallets Supporting WalletConnect on Beacon Chain +* List of Wallets Supporting WalletConnect on BNB Beacon Chain | Number | Wallet Name | Network | @@ -33,13 +33,13 @@ Currently the WalletConnect protocol has references implementations written in T To learn more about how to develop, please read the [official documentation](https://docs.walletconnect.org/). -The Beacon Chain Web Wallet supports connecting with external wallet providers via the [WalletConnect protocol](https://docs.walletconnect.org/tech-spec). +The BNB Beacon Chain Web Wallet supports connecting with external wallet providers via the [WalletConnect protocol](https://docs.walletconnect.org/tech-spec). WalletConnect allows the user to scan a QR code from the wallet app to unlock and use their wallet seamlessly in the web UI. -In order for this to work, some modifications to the standard WalletConnect protocol are used in the Beacon Chain wallet's implementation. +In order for this to work, some modifications to the standard WalletConnect protocol are used in the BNB Beacon Chain wallet's implementation. -See the list of wallets which support WalletConnect on Beacon Chain [here](../../wallets/walletconnect-support.md) +See the list of wallets which support WalletConnect on BNB Beacon Chain [here](../../wallets/walletconnect-support.md) ## Connecting via WalletConnect @@ -49,7 +49,7 @@ Wallet providers should make use of the [WalletConnect Client SDK](https://docs. Since we do not use Ethereum transactions, there are some differences: -* Typically `sendTransaction` is used with Ethereum transaction parameters in WalletConnect dApp integrations. But in Beacon Chain 's case, instead of invoking `sendTransaction` in the WalletConnect flow, the new [`sendCustomRequest`](https://docs.walletconnect.org/client-sdk#send-custom-request) call is used instead with a method called `bnb_sign` (see below). +* Typically `sendTransaction` is used with Ethereum transaction parameters in WalletConnect dApp integrations. But in BNB Beacon Chain 's case, instead of invoking `sendTransaction` in the WalletConnect flow, the new [`sendCustomRequest`](https://docs.walletconnect.org/client-sdk#send-custom-request) call is used instead with a method called `bnb_sign` (see below). * The external wallet provider is responsible for sending back the signature and public key of the transaction but should _not_ broadcast the transaction itself. We have instead defined a custom `result` format in the form of stringified JSON containing the signature and public key. The reason for this is that the wallet app probably does not have access to the complete serialized binary form of the transaction (as this requires Amino encoding). diff --git a/docs/beaconchain/light-client.md b/docs/beaconchain/light-client.md index cf8951ef6e..b67ee55f07 100644 --- a/docs/beaconchain/light-client.md +++ b/docs/beaconchain/light-client.md @@ -1,6 +1,6 @@ # Light Client -Light client is a program that connects to a full node to help users access and interact with Beacon Chain +Light client is a program that connects to a full node to help users access and interact with BNB Beacon Chain in a secure and decentralized manner without having to sync the full blockchain. ## Light Client Versus Full Node @@ -47,7 +47,7 @@ Usage: Flags: --cache-size int Specify the memory trust store cache size (default 10) - --chain-id string Specify the Beacon Chain ID (default "bnbchain") + --chain-id string Specify the BNB Beacon Chain ID (default "bnbchain") -h, --help help for lite --home-dir string Specify the home directory (default ".binance-lite") --laddr string Serve the proxy on the given address (default "tcp://localhost:27147") @@ -68,7 +68,7 @@ The `chain id` of the network that you want join in.
You can find chain id at [genesis file in test network](https://github.com/bnb-chain/node/releases/download/v0.9.1/testnet_config.zip) or [genesis file in prod network](https://github.com/bnb-chain/node/releases/download/v0.9.1/mainnet_config.zip).
The `full node addr` field can be an address of any full node that you have deployed.
-You can refer to [Run a Beacon Chain full node](fullnode.md) to get more details.
+You can refer to [Run a BNB Beacon Chain full node](fullnode.md) to get more details.
We supply a bunch of full nodes that you can connect to for both mainnet and testnet.
You cat get full nodes info through a simple python script(notice to replace domain according to different network):
diff --git a/docs/beaconchain/list.md b/docs/beaconchain/list.md index 84e9d83fd3..fce04f8a44 100644 --- a/docs/beaconchain/list.md +++ b/docs/beaconchain/list.md @@ -1,6 +1,6 @@ # List Transaction -Only [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md) tokens issued on Beacon Chain can be listed. Learn how to issue BEP2 tokens [here](tokens.md). If a token's listing proposal has been passed by valdiators, then a `list` transaction must be sent before `expire-time`. +Only [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md) tokens issued on BNB Beacon Chain can be listed. Learn how to issue BEP2 tokens [here](tokens.md). If a token's listing proposal has been passed by valdiators, then a `list` transaction must be sent before `expire-time`. ## List Fee Fees will be charge when issuing a token, creating a proposal, depositing and listing. You can refer to [fee table in trading spec](trading-spec.md). diff --git a/docs/beaconchain/list_instruction.md b/docs/beaconchain/list_instruction.md index 7f361674c5..ce1617d619 100644 --- a/docs/beaconchain/list_instruction.md +++ b/docs/beaconchain/list_instruction.md @@ -6,25 +6,25 @@ There are the steps to get your tokens listed: ![workflow](../assets/listing-workflow.jpg) -## 1. Issue Tokens on Beacon Chain -Please refer to this [token issue doc](tokens.md) to learn about how to issue your own asset on Beacon Chain . +## 1. Issue Tokens on BNB Beacon Chain +Please refer to this [token issue doc](tokens.md) to learn about how to issue your own asset on BNB Beacon Chain . ## 2. Submit Proposal *On-Chain Proposal Request* -Please refer to this [governance doc](governance.md) to learn about how to create a proposal about listing a new trading pair on Beacon Chain . +Please refer to this [governance doc](governance.md) to learn about how to create a proposal about listing a new trading pair on BNB Beacon Chain . > Please ensure that you test EVERYTHING on our testnet (multiple times at least) before you officially execute this on the mainnet. *Community Thread Proposal (Recommended)* -It is recommended that Token Issuers first create a thread under the “Token Issuance & Listings” category in the Beacon Chain Community Forum (https://community.binance.org/). The whole guideline is [here](https://community.binance.org/topic/18/guidelines-on-how-to-list-your-token-on-binance-dex) +It is recommended that Token Issuers first create a thread under the “Token Issuance & Listings” category in the BNB Beacon Chain Community Forum (https://community.binance.org/). The whole guideline is [here](https://community.binance.org/topic/18/guidelines-on-how-to-list-your-token-on-binance-dex) ## 3. Send List Transaction -Please refer to this [list doc](list.md) to learn about how to send a list transaction and finish listing process on Beacon Chain . +Please refer to this [list doc](list.md) to learn about how to send a list transaction and finish listing process on BNB Beacon Chain . > Please ensure that a `list` transaction must be sent before `expire-time`. @@ -33,7 +33,7 @@ Please refer to this [list doc](list.md) to learn about how to send a list trans ### Which trading pair can be listed? -Simply allowing trading between two assets seems easy enough, however it is expensive for not only the network but also its users in long term (and liquidity costs can be much larger). In order to efficiently use the network, Beacon Chain only list assets against BNB and other widely accepted market quote assets. +Simply allowing trading between two assets seems easy enough, however it is expensive for not only the network but also its users in long term (and liquidity costs can be much larger). In order to efficiently use the network, BNB Beacon Chain only list assets against BNB and other widely accepted market quote assets. ### How is a trading pair created on Binance DEX? diff --git a/docs/beaconchain/resources.md b/docs/beaconchain/resources.md index 5372a56982..a4da8e0bd0 100644 --- a/docs/beaconchain/resources.md +++ b/docs/beaconchain/resources.md @@ -2,6 +2,6 @@ You can always post your question in [Online Forum](https://community.binance.org): this is the main portal to get community support. -To keep track of the latest news in Beacon Chain /DEX, you can read our weekly updates. It will be published on [Online Forum](https://community.binance.org) too. +To keep track of the latest news in BNB Beacon Chain /DEX, you can read our weekly updates. It will be published on [Online Forum](https://community.binance.org) too. Binance DEX does not have Customer Support Service on Telegram! diff --git a/docs/beaconchain/timelock.md b/docs/beaconchain/timelock.md index 1c19f8e2cc..f69ca28076 100644 --- a/docs/beaconchain/timelock.md +++ b/docs/beaconchain/timelock.md @@ -5,7 +5,7 @@ As explained in [BEP9](https://github.com/bnb-chain/BEPs/blob/master/BEP9.md), s ## TimeLock -You can only lock tokens on your own account. TimeLock will transfer locked tokens to a purely-code-controlled escrow account and before the lock time expires. A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): +You can only lock tokens on your own account. TimeLock will transfer locked tokens to a purely-code-controlled escrow account and before the lock time expires. A purely-code-controlled escrow account is a kind of account which is derived from a hard-coded string in BNB Beacon Chain protocol. This kind of account doesn't have its own private key and it's only controlled by code of the protocol. The code for calculating escrow account is the same that is used in [cosmos-sdk](https://github.com/cosmos/cosmos-sdk/blob/82a2c5d6d86ffd761f0162b93f0aaa57b7f66fe7/x/supply/internal/types/account.go#L40): ``` TimeLockCoinsAccAddr = sdk.AccAddress(crypto.AddressHash([]byte("BinanceChainTimeLockCoins"))) ``` diff --git a/docs/beaconchain/tokens.md b/docs/beaconchain/tokens.md index 1055a87e05..eab612f3c2 100644 --- a/docs/beaconchain/tokens.md +++ b/docs/beaconchain/tokens.md @@ -1,7 +1,7 @@ # Asset Management ## Introduction -Assets are stored as `tokens` on Beacon Chain , and the below management actions are available. All the assets are complied with [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). +Assets are stored as `tokens` on BNB Beacon Chain , and the below management actions are available. All the assets are complied with [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). The [fees](trading-spec.md#fees) that are due must be paid in BNB before any of these operations can be executed. The fees for testnet and mainnet are different. @@ -110,7 +110,7 @@ Example on **testnet**: ## TransferOwnership -> Note: [BEP82](https://github.com/binance-chain/BEPs/pull/82) is implemented after Lagrange Upgrade to add this new transactionn type. +> Note: [BEP82](https://github.com/bnb-chain/BEPs/pull/82) is implemented after Lagrange Upgrade to add this new transactionn type. **0.01 BNB** will be charged on **TransferOwnership** transactions. diff --git a/docs/beaconchain/trading-spec.md b/docs/beaconchain/trading-spec.md index d2f63f09d1..703ce1b3b7 100644 --- a/docs/beaconchain/trading-spec.md +++ b/docs/beaconchain/trading-spec.md @@ -3,7 +3,7 @@ ## Orders Orders are the requests for client to buy or sell tokens into other tokens on Binance DEX. -It is a standard type of Beacon Chain transaction. Orders are composed of the below parameters. +It is a standard type of BNB Beacon Chain transaction. Orders are composed of the below parameters. 0. Symbol Pairs: the list pair the order wants to trade. 1. Order Type: Binance DEX only accept LIMIT orders, which is adhering to SEC definitions of LIMIT orders @@ -59,7 +59,7 @@ For GTE order, if a GTE order can execute against another order as a whole, the Order would expire after 72 hours once it is booked on a block. A whole order book scan would happen every UTC mid-night to filter out all the expired orders. After the scan, all the expired orders would be removed from the order book, the locked quantity in the account would be unlocked. Before this action all the existing orders in the order book is subject to matching. !!! Tip - As discussed in [BEP-67](https://github.com/bnb-chain/BEPs/blob/master/BEP67.md), those orders in the best 500 price levels on both ask and bid side will be expired after **30 days** instead of 72 hours. Meanwhile, the expiration fee is unchanged. BEP67 is already implemented and has been activated after Testnet Nightingale Upgrade. Beacon Chain Mainnet will be upgraded to support BEP-67 soon. + As discussed in [BEP-67](https://github.com/bnb-chain/BEPs/blob/master/BEP67.md), those orders in the best 500 price levels on both ask and bid side will be expired after **30 days** instead of 72 hours. Meanwhile, the expiration fee is unchanged. BEP67 is already implemented and has been activated after Testnet Nightingale Upgrade. BNB Beacon Chain Mainnet will be upgraded to support BEP-67 soon. ## Precision diff --git a/docs/beaconchain/transfer.md b/docs/beaconchain/transfer.md index 407ed0ed8d..e361b1fddb 100644 --- a/docs/beaconchain/transfer.md +++ b/docs/beaconchain/transfer.md @@ -1,6 +1,6 @@ # Asset Transfer -`Transfer` is the most basic transaction Beacon Chain supports, it moves assets among different addresses. +`Transfer` is the most basic transaction BNB Beacon Chain supports, it moves assets among different addresses. Please note the fees must be paid first in BNB before the transaction can be executed. @@ -169,7 +169,7 @@ Flags: --account-number int AccountNumber number to sign the tx --amount string Amount of coins to send --async broadcast transactions asynchronously - --chain-id string Chain ID of Beacon Chain node + --chain-id string Chain ID of BNB Beacon Chain node --dry-run ignore the perform a simulation of a transaction, but don't broadcast it --from string Name or address of private key with which to sign --generate-only build an unsigned transaction and write it to STDOUT diff --git a/docs/beaconchain/tss.md b/docs/beaconchain/tss.md index 4b37b4c550..79f12da53e 100644 --- a/docs/beaconchain/tss.md +++ b/docs/beaconchain/tss.md @@ -1,4 +1,4 @@ -# User Guide of Threshold Signature Scheme (TSS) in Beacon Chain +# User Guide of Threshold Signature Scheme (TSS) in BNB Beacon Chain ## Introduction @@ -11,20 +11,20 @@ Traditional **MultiSig (multi-signature)** is a more refined unlocking system th With **Threshold Signatures**, all of the parties must forge the vault’s lock together, in a modular way, where each party owns a share of the key. A TSS vault is indistinguishable from a regular vault and is hence universal, and it has the same privacy and verification cost of a regular vault. Even if only a subset of the keys is available, the vault may still be unlocked (this is known as meeting a threshold of participation). -Combining TSS feature with Beacon Chain client will help users manage their funds in a much safer way. TSS will be offered in an independent binary, but it will have some impact on the existing functions of *bnbcli/tbnbcli*. +Combining TSS feature with BNB Beacon Chain client will help users manage their funds in a much safer way. TSS will be offered in an independent binary, but it will have some impact on the existing functions of *bnbcli/tbnbcli*. ## Implementation -Many development resources have been poured into implementing TSS, a cryptographic protocol for distributed key generation and signing. TSS is now compatible and reusable for ECDSA-based blockchains, including Beacon Chain, Bitcoin, and Ethereum networks. We expect that members of the BNB Chain ecosystem and partner community can integrate this TSS library with their applications, such as wallets and custodians, and further develop this exciting new technology. +Many development resources have been poured into implementing TSS, a cryptographic protocol for distributed key generation and signing. TSS is now compatible and reusable for ECDSA-based blockchains, including BNB Beacon Chain, Bitcoin, and Ethereum networks. We expect that members of the BNB Chain ecosystem and partner community can integrate this TSS library with their applications, such as wallets and custodians, and further develop this exciting new technology. -With the support of the Beacon Chain community, we are happy to share the open-source code at https://github.com/bnb-chain/tss-lib. +With the support of the BNB Beacon Chain community, we are happy to share the open-source code at https://github.com/bnb-chain/tss-lib. ## Security Audit The implementation of a multi-party threshold ECDSA [library](https://github.com/bnb-chain/tss-lib) is open source so it can be publicly audited by anyone. An independent third party auditors from [Kudelski Security](https://www.kudelskisecurity.com/) are hired to validate the security of the cryptography in TSS solution. The latest report in October by can be found [here](./assets/audit-binance-tss-lib-final.pdf). -Security checks are routinely and continuously planned for all parts of TSS lib implementations and future audits will be reported to Beacon Chain community. +Security checks are routinely and continuously planned for all parts of TSS lib implementations and future audits will be reported to BNB Beacon Chain community. ## Workflow Let’s take a look at the major steps in TSS: @@ -35,14 +35,14 @@ Let’s take a look at the major steps in TSS: * **Signing**: this step involves a signature generation function. The input of each party will be its own secret share, created as output of the distributed key generation in the previous step. There is also public input known to all, which is the message to be signed. The output will be a digital signature, and the property of privacy ensures that no leakage of secret shares occurred during the computation. -* **Verification**: the verification algorithm remains as it is in the classical setting. To be compatible with single key signatures, Beacon Chain validator nodes can be able to verify the signature with the public key. The transaction will be no different from others. +* **Verification**: the verification algorithm remains as it is in the classical setting. To be compatible with single key signatures, BNB Beacon Chain validator nodes can be able to verify the signature with the public key. The transaction will be no different from others. * **Vault Regroup**: Regroup will reset secret share and configs between all parties.It's recommend to switch the configuration periodically, say once a month. If some party lost his key, it's also necessory to reset the distribution once some party lost their key. Regroup will generate new_n secret share with new_t threshold. At least old_t + 1 should participant ## Where can I download the Binance TSS CLI? -You can download tss client and Beacon Chain Commandline here: +You can download tss client and BNB Beacon Chain Commandline here: * Mainnet: diff --git a/docs/beaconchain/validator/create-val.md b/docs/beaconchain/validator/create-val.md index b270e7dcb5..f30e056c7e 100644 --- a/docs/beaconchain/validator/create-val.md +++ b/docs/beaconchain/validator/create-val.md @@ -17,7 +17,7 @@ There is an on-chain parameter `MaxValidators`. Only the validator candidates wh ## Become a Validator Candidate -You will need [Beacon Chain CLI](../develop/api-reference/cli.md) for the commands. +You will need [BNB Beacon Chain CLI](../develop/api-reference/cli.md) for the commands. ### Step1: Generate Consensus Key Use the command below to generate a consensus key. It will be used in the full node to sign the consensus message if the validator gets bonded. diff --git a/docs/beaconchain/validator/overview.md b/docs/beaconchain/validator/overview.md index a08b9e4048..f142800e4e 100644 --- a/docs/beaconchain/validator/overview.md +++ b/docs/beaconchain/validator/overview.md @@ -6,7 +6,7 @@ hide_table_of_contents: false # Overview [BEP159](https://github.com/bnb-chain/BEPs/blob/master/BEP159.md) introduces a permissionless validator election mechanism -and brings the staking economy onto Beacon Chain(BC). +and brings the staking economy onto BNB Beacon Chain(BC). Anyone can stake their BNB to become a validator candidate or delegate their BNB to the validator candidates they trust. The validator set will be determined by the rank of the accumulated bonded tokens on validator candidates. The validators diff --git a/docs/beaconchain/wallet/tutorial/bep8.md b/docs/beaconchain/wallet/tutorial/bep8.md index 4696ab95b3..e1c26e3aee 100644 --- a/docs/beaconchain/wallet/tutorial/bep8.md +++ b/docs/beaconchain/wallet/tutorial/bep8.md @@ -3,9 +3,9 @@ In this article, we are going to take a tour about how to manage your BEP8 tokens in BNB Chain Testnet [web wallet](https://testnet.binance.org/en/tokens). ## What is BEP8 Token -Since the [Nightingale upgrade](https://community.binance.org/topic/2828) of Beacon Chain testnet, a new token protocol [BEP8](https://github.com/bnb-chain/BEPs/blob/master/BEP8.md) is introduced. BEP8 protocol targets a different marketplace and provides several potential business cases in areas like micro-financing. +Since the [Nightingale upgrade](https://community.binance.org/topic/2828) of BNB Beacon Chain testnet, a new token protocol [BEP8](https://github.com/bnb-chain/BEPs/blob/master/BEP8.md) is introduced. BEP8 protocol targets a different marketplace and provides several potential business cases in areas like micro-financing. -Currently, the cost to get a BEP2 token issued on Beacon Chain is not very cheap, as it takes more system resources, which is more suitable for the mature and large scale projects with enough recognition in the markets. At the same time, more micro-financing cases like copyright owners, peer production, and community incentive points are looking for flexible tokenization and trading platforms to support their current works and share their potential future success. New BEP8 tokens protocol is introduced to meet these demands and will increase the liquidity of utility tokens, which is similar to Small and Medium Enterprise (SME) board in the traditional stock markets. +Currently, the cost to get a BEP2 token issued on BNB Beacon Chain is not very cheap, as it takes more system resources, which is more suitable for the mature and large scale projects with enough recognition in the markets. At the same time, more micro-financing cases like copyright owners, peer production, and community incentive points are looking for flexible tokenization and trading platforms to support their current works and share their potential future success. New BEP8 tokens protocol is introduced to meet these demands and will increase the liquidity of utility tokens, which is similar to Small and Medium Enterprise (SME) board in the traditional stock markets. ## Issue BEP8 Token diff --git a/docs/beaconchain/wallet/tutorial/ledger-nano-s-usage-guide.md b/docs/beaconchain/wallet/tutorial/ledger-nano-s-usage-guide.md index 786a18e0d7..6325537119 100644 --- a/docs/beaconchain/wallet/tutorial/ledger-nano-s-usage-guide.md +++ b/docs/beaconchain/wallet/tutorial/ledger-nano-s-usage-guide.md @@ -1,16 +1,16 @@ # Ledger Nano S Usage Guide -This guide will show you how to use your Ledger Nano S hardware wallet with Beacon Chain and Binance DEX. +This guide will show you how to use your Ledger Nano S hardware wallet with BNB Beacon Chain and Binance DEX. -> Please Note: When using a Ledger to secure your Beacon Chain wallet, your private keys are not exposed and never leave the device, guarding you against loss, malware and phishing attacks. +> Please Note: When using a Ledger to secure your BNB Beacon Chain wallet, your private keys are not exposed and never leave the device, guarding you against loss, malware and phishing attacks. Therefore, using a hardware wallet device such as the Ledger Nano S is strongly recommended over using a less secure wallet storage method that relies on your computer’s local storage, such as Keystore File. ## Requirements -In order to use a Ledger device with Beacon Chain and Binance DEX, you will need: +In order to use a Ledger device with BNB Beacon Chain and Binance DEX, you will need: - Supported web browser: Chrome (including Brave, Vivaldi, and other Chromium variants), Opera or Firefox -- Access to the Beacon Chain web wallet (https://binance.org/unlock) using your web browser +- Access to the BNB Beacon Chain web wallet (https://binance.org/unlock) using your web browser - Initialized Ledger Nano S device with firmware version 1.5.5 or newer - The Ledger Live application installed on your computer for app installation @@ -21,7 +21,7 @@ In order to use a Ledger device with Beacon Chain and Binance DEX, you will need ![img](assets/ledger-nano-s-usage-guide/manage.png) 2) Within the "Manager" pane, type in "Binance" in the search field.
-Locate "Beacon Chain ", then click on "Install". +Locate "BNB Beacon Chain ", then click on "Install". ![img](assets/ledger-nano-s-usage-guide/install.png) @@ -32,12 +32,12 @@ Locate "Beacon Chain ", then click on "Install". ![img](assets/ledger-nano-s-usage-guide/installing.png) -4) When you see a popup message indicating "Successfully installed Beacon Chain ", the installation is complete. +4) When you see a popup message indicating "Successfully installed BNB Beacon Chain ", the installation is complete. ![img](assets/ledger-nano-s-usage-guide/success.png) -5) Check that the "Beacon Chain " app is shown on your Ledger device dashboard as in the photo below.
+5) Check that the "BNB Beacon Chain " app is shown on your Ledger device dashboard as in the photo below.
If it is, the installation has been successful. ![img](assets/ledger-nano-s-usage-guide/app.png) @@ -61,7 +61,7 @@ You will then be redirected to the Trading Interface. For your security, please read the information displayed in the following popup and confirm that the address shown on your Ledger device matches the one shown on-screen.
Press the right button on your device to confirm that the address matches (You must do this to continue). -## How to send Beacon Chain Crypto Assets +## How to send BNB Beacon Chain Crypto Assets Confirming a trade on a Ledger Wallet: diff --git a/docs/beaconchain/wallet/tutorial/trezor-model-t-user-guide.md b/docs/beaconchain/wallet/tutorial/trezor-model-t-user-guide.md index 2ca8fe179b..cdf66d1d65 100644 --- a/docs/beaconchain/wallet/tutorial/trezor-model-t-user-guide.md +++ b/docs/beaconchain/wallet/tutorial/trezor-model-t-user-guide.md @@ -1,13 +1,13 @@ # Trezor User Guide -This guide will show you how to use your [Trezor Model T](https://shop.trezor.io/product/trezor-model-t) hardware wallet with Beacon Chain and Binance DEX. +This guide will show you how to use your [Trezor Model T](https://shop.trezor.io/product/trezor-model-t) hardware wallet with BNB Beacon Chain and Binance DEX. Please follow best security practices when using any hardware wallet to store cryptocurrency. > Please note that the Trezor Model One is not supported yet. ## Requirements -In order to use a Trezor with Beacon Chain and Binance DEX, you will need: +In order to use a Trezor with BNB Beacon Chain and Binance DEX, you will need: * A supported web browser: Chrome or Firefox -* Access to the Beacon Chain web wallet (https://binance.org/unlock) using your web browser +* Access to the BNB Beacon Chain web wallet (https://binance.org/unlock) using your web browser * An initialized Trezor Model T device with the most recent firmware updates installed * The Trezor Bridge application installed on your computer @@ -54,7 +54,7 @@ Please make sure that you have seed phrase backed up. ![img](https://lh4.googleusercontent.com/d2YxOhj8kptDdPmwJ1QIWKn57BeHooCmR_6NYBH1FqRxxlMDm5PaOvz07HV9KGuUR3K-WG70n83v7vvOZ8WOe_kcippxedz3N4JV1DLlPLNXg_tQg0HoDiBrLy_tZS9hh5b4wREX) -> Please note that Trezor only supports the Beacon Chain mainnet +> Please note that Trezor only supports the BNB Beacon Chain mainnet 1) Click on the “Balances” navigation button in the Trading Interface to view your account balances. @@ -64,7 +64,7 @@ Please make sure that you have seed phrase backed up. ![img](https://lh6.googleusercontent.com/h7xez7MrpBQt8n888v8mmWujn4rNKH88h11zesBkBe-pvCKtqiPM_IE3MZRRGuQi47DOLRAgrVMY3g8a-QXvhkpnJOLacHgyTeUe5FvKT2LAVTX7t8NMfaHdzoP53dbbG4pz4j_2) -## How to send Beacon Chain crypto assets +## How to send BNB Beacon Chain crypto assets 1) Click on the “Balances” navigation button in the Trading Interface to view your account balances. @@ -85,7 +85,7 @@ Please make sure that you have seed phrase backed up. ![img](https://lh4.googleusercontent.com/CgV9tpPpgGZFowBeka3VUqgA5zCfT7gLxi3m1qujN00lFKGJu8uSoTpP8_VnF5qCasdPHb-S2FQEEKHGm37xjXJhCmxyxvpWN_mQ6CHb6Q4aCaHb4Y4MmOeZrUibQeGLPtyqFON2) -## How to trade Beacon Chain crypto assets +## How to trade BNB Beacon Chain crypto assets 1) You can place your order on trading page diff --git a/docs/beaconchain/walletconnect.md b/docs/beaconchain/walletconnect.md index 38ae9d03d2..d4af48587f 100644 --- a/docs/beaconchain/walletconnect.md +++ b/docs/beaconchain/walletconnect.md @@ -6,13 +6,13 @@ sidebar_position: 2 # Wallet Connect -The Beacon Chain Web Wallet supports connecting with external wallet providers via the [WalletConnect protocol](https://docs.walletconnect.org/tech-spec). +The BNB Beacon Chain Web Wallet supports connecting with external wallet providers via the [WalletConnect protocol](https://docs.walletconnect.org/tech-spec). WalletConnect allows the user to scan a QR code from the wallet app to unlock and use their wallet seamlessly in the web UI. -In order for this to work, some modifications to the standard WalletConnect protocol are used in the Beacon Chain wallet's implementation. +In order for this to work, some modifications to the standard WalletConnect protocol are used in the BNB Beacon Chain wallet's implementation. -See the list of wallets which support WalletConnect on Beacon Chain [here](walletconnect-support.md) +See the list of wallets which support WalletConnect on BNB Beacon Chain [here](walletconnect-support.md) ## Connecting via WalletConnect @@ -22,7 +22,7 @@ Wallet providers should make use of the [WalletConnect Client SDK](https://docs. Since we do not use Ethereum transactions, there are some differences: -* Typically `sendTransaction` is used with Ethereum transaction parameters in WalletConnect dApp integrations. But in Beacon Chain 's case, instead of invoking `sendTransaction` in the WalletConnect flow, the new [`sendCustomRequest`](https://docs.walletconnect.org/client-sdk#send-custom-request) call is used instead with a method called `bnb_sign` (see below). +* Typically `sendTransaction` is used with Ethereum transaction parameters in WalletConnect dApp integrations. But in BNB Beacon Chain 's case, instead of invoking `sendTransaction` in the WalletConnect flow, the new [`sendCustomRequest`](https://docs.walletconnect.org/client-sdk#send-custom-request) call is used instead with a method called `bnb_sign` (see below). * The external wallet provider is responsible for sending back the signature and public key of the transaction but should _not_ broadcast the transaction itself. We have instead defined a custom `result` format in the form of stringified JSON containing the signature and public key. The reason for this is that the wallet app probably does not have access to the complete serialized binary form of the transaction (as this requires Amino encoding). diff --git a/docs/beaconchain/wallets.md b/docs/beaconchain/wallets.md index 6f02b3efbd..3bf7a5f803 100644 --- a/docs/beaconchain/wallets.md +++ b/docs/beaconchain/wallets.md @@ -1,6 +1,6 @@ # Supported Wallets -* List of Wallets Supporting Beacon Chain Mainnet +* List of Wallets Supporting BNB Beacon Chain Mainnet | Number | Wallet Name | Website |DEX Feature Available|Testnet Support|WalletConnect Support| | ------ | ------------------------------------------------------ | -------------------------------- |-----| -----|-----| diff --git a/docs/binance.md b/docs/binance.md index b35c5756d9..946320bec2 100644 --- a/docs/binance.md +++ b/docs/binance.md @@ -7,7 +7,7 @@ hide_table_of_contents: false # Use Binance Extension Wallet ## What is it? -Binance Extension Wallet is a Crypto Wallet for Beacon Chain, BNB Smart Chain. You can send and receive funds on Beacon Chain, BNB Smart Chain and cross-chain transfers between both of BNB Chain’s blockchains. +Binance Extension Wallet is a Crypto Wallet for BNB Beacon Chain, BNB Smart Chain. You can send and receive funds on BNB Beacon Chain, BNB Smart Chain and cross-chain transfers between both of BNB Chain’s blockchains. In the future, Binance Extension Wallet will add support for Ethereum blockchain and enable access for distributed applications, or "Dapps" in your browser! @@ -105,7 +105,7 @@ After the transfer transaction is sent, you will see an increase in your balance ![img](https://lh6.googleusercontent.com/RTAOcHcPxUIthhOLlHHJ1_wrFnvmZvbZ4DJUvpNR453E4mnWWRjHLBEABMTZZdSQGYMktX5eXJPOIt7iEijMsbmMJBEL29RAShDBD8ZRIDiCnXpfwi741DM7-XiDDyJO4uiLHyNL) ## Transfer Testnet BNB from BSC to BC -* Switch to Beacon Chain testnet and copy your address after unlock your extension wallet, start with `tbnb1` +* Switch to BNB Beacon Chain testnet and copy your address after unlock your extension wallet, start with `tbnb1` ![img](https://lh3.googleusercontent.com/K5w_Mbk4rT9Az6eIY130MHaj_ZCicU4Tp3w93z40dtrGdzwFCMZ5qAfwytI5PY_TdztTPrK5WPAf1uHM5ej-1YdEWu7GtVgghRBub1KSf0e63tgi1L-4MkwPBG3pG0SDYHfMpt_J) diff --git a/docs/cross.md b/docs/cross.md index c41e02bd98..942bc2eb09 100644 --- a/docs/cross.md +++ b/docs/cross.md @@ -10,7 +10,7 @@ sidebar_position: 2 The total cost of transfer from BC to BSC is composed of 2 parts: -* Fee for executing `bridge transfer-out` transaction is 0.004BNB, pay validators on Beacon Chain +* Fee for executing `bridge transfer-out` transaction is 0.004BNB, pay validators on BNB Beacon Chain * Fee for BSC-relayers 0.004BNB. it will cover the fees of calling TokenHub Contract on BSC. @@ -22,11 +22,11 @@ The total cost of transfer from BSC to BC is composed of 2 parts: ### What's is a BSC relayer? -BSC relayer monitors cross chain packages on Beacon Chain, builds and broadcasts transactions to BSC to deliver these packages, which is the key of cross chain communication from Beacon Chain to BSC. +BSC relayer monitors cross chain packages on BNB Beacon Chain, builds and broadcasts transactions to BSC to deliver these packages, which is the key of cross chain communication from BNB Beacon Chain to BSC. ### What's is an Oracle relayer? -Oracle Relayer watches the state change of BNB Smart Chain. Once it catches Cross-Chain Communication Events, it will submit to vote for the requests. After Oracle Relayers from ⅔ of the voting power of BC validators vote for the changes, the cross-chain actions will be performed. Only validators of Beacon Chain are eligible to run Oracle relayers. +Oracle Relayer watches the state change of BNB Smart Chain. Once it catches Cross-Chain Communication Events, it will submit to vote for the requests. After Oracle Relayers from ⅔ of the voting power of BC validators vote for the changes, the cross-chain actions will be performed. Only validators of BNB Beacon Chain are eligible to run Oracle relayers. ### What's an oracle? diff --git a/docs/dev-outlook/decentralization.md b/docs/dev-outlook/decentralization.md index 8352098993..3b29d7a8b8 100644 --- a/docs/dev-outlook/decentralization.md +++ b/docs/dev-outlook/decentralization.md @@ -14,7 +14,7 @@ BSC will introduce more validators, e.g. another 20 inactive validators, into th Candidates will produce blocks and charge gas fees in BSC mainnet, but in a much less chance than the official validator set of 29 elected. The unavailable candidates will be slashed as well though in a smaller size. A decent motivation is expected to be maintained so that the candidate validators are willing to ensure the quality and help secure BSC. -In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to Beacon Chain about the stale blocking, resume it and eventually propose a re-election of active validator set. +In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to BNB Beacon Chain about the stale blocking, resume it and eventually propose a re-election of active validator set. ## Temporary Maintenance Mode for Validators Due to the design of ‘Parlia’ consensus, the absence of the validator, even if it is due to scheduled maintenance, will cause instability and capacity of BSC due to the extra waiting time and chain reorganization. diff --git a/docs/dev-outlook/scaling.md b/docs/dev-outlook/scaling.md index f2b14a6d36..4f8c7006e1 100644 --- a/docs/dev-outlook/scaling.md +++ b/docs/dev-outlook/scaling.md @@ -29,7 +29,7 @@ For high performance computing, it is almost impossible to only rely on one node Running different functions of a blockchain client on different processes or machines are not new. Erigon proposes to run the RPC function in a standalone process on the same or different machine. The Merge of ETH 2.0 will also decompose the consensus and execution layers onto different client softwares. -A typical blockchain client comprises many functionalities, P2P networking, consensus, RPC service, execution layer etc. Even zooming in these parts, e.g. the execution layer, is composed of many steps, such as the computing of transactions, the state persistence and the generation of different MPT(Merkle Patricia Trie) roots. Decoupling the functions onto different processes and machines can take advantage of the better computing and storage capacity. Some community members have started [some trials](https://github.com/binance-chain/bsc/pull/640). However, distributing the node also poses great challenges, especially on synchronization between the distributed sub-nodes without losing the blockchain network security, i.e. the full node operators can easily run the suite of processes to keep the network running with the same level of security but much more capacity. +A typical blockchain client comprises many functionalities, P2P networking, consensus, RPC service, execution layer etc. Even zooming in these parts, e.g. the execution layer, is composed of many steps, such as the computing of transactions, the state persistence and the generation of different MPT(Merkle Patricia Trie) roots. Decoupling the functions onto different processes and machines can take advantage of the better computing and storage capacity. Some community members have started [some trials](https://github.com/bnb-chain/bsc/pull/640). However, distributing the node also poses great challenges, especially on synchronization between the distributed sub-nodes without losing the blockchain network security, i.e. the full node operators can easily run the suite of processes to keep the network running with the same level of security but much more capacity. A straightforward approach may be to arrange the tasks in a “synchronized, distributed, assembly line” (SDAL), due to the sequential characteristics of the blockchain. Some change may be required on the consensus logic to make this type optimization easier. This is also discussed in other blockchains that break sequencing, execution and storage (settlement) into different components. @@ -80,4 +80,4 @@ Although BSC is designed to produce blocks every 3 seconds, it is recommended to As the validator set is well known every 24 hours, BSC can get a faster consensus on the longest chain based on the “attestation” from more than a certain percentage of the validator set considering it is the longest chain. -This essentially requires altering the “Parlia” consensus mechanism of BSC. A BEP candidate has been proposed by the community at [[WIP] BEP-97: Introduce Fast Finality Mechanism by KeefeL · Pull Request #126 · binance-chain/BEPs · GitHub](https://github.com/binance-chain/BEPs/pull/126) \ No newline at end of file +This essentially requires altering the “Parlia” consensus mechanism of BSC. A BEP candidate has been proposed by the community at [[WIP] BEP-97: Introduce Fast Finality Mechanism by KeefeL · Pull Request #126 · binance-chain/BEPs · GitHub](https://github.com/bnb-chain/BEPs/pull/126) \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 77c4f4e2bf..a5d965a779 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -60,9 +60,9 @@ Remember transactions can’t be reversed and wallets can’t be easily recovere Many users who interact with a centralized exchange like Binance eventually want to withdraw to a wallet that they fully control, like MetaMask. So once you've used their withdraw form, what could be scarier than not seeing your tokens? -First, you'll need to use the MetaMask add Custom Network feature to add the Beacon Chain or BNB Smart Chain's RPC URLs endpoints to your MetaMask. +First, you'll need to use the MetaMask add Custom Network feature to add the BNB Beacon Chain or BNB Smart Chain's RPC URLs endpoints to your MetaMask. -Once you've added the Beacon Chain or the BNB Smart Chain to your MetaMask, you will be able to select different networks to view the assets (you may need to add Custom Tokens too) held by your selected account on that network. +Once you've added the BNB Beacon Chain or the BNB Smart Chain to your MetaMask, you will be able to select different networks to view the assets (you may need to add Custom Tokens too) held by your selected account on that network. ## How Much BNB You Need To Send Tokens @@ -155,7 +155,7 @@ When resetting your password for your Binance Extension wallet, you will need yo ![img](https://lh6.googleusercontent.com/ZeM4cYV3rirCo91zw3OVMYRqqpwqIsrWhPnv-t3sL7YhpD0M_DNQ4QQH-Rw8WmapLrX2OzwETLKcEwKA-Rakjuhlnoy7S707Yt8Y0nUC5OKjg04ADgM2bLSb-1f3GZvUxdkj-BuI) ## Which network does BEW support? - * Beacon Chain (BEP2) + * BNB Beacon Chain (BEP2) * BNB Smart Chain (BEP20) * Ethereum (ERC20) @@ -163,7 +163,7 @@ When resetting your password for your Binance Extension wallet, you will need yo !!! Note : By default each wallet/network will shows the the main token they support. You will need to add additional token to your list. **For Binance Extension Wallet users** -You'll need to switch to Beacon Chain Mainnet (BC) mainnet or BNB Smart Chain (BSC) mainnet +You'll need to switch to BNB Beacon Chain Mainnet (BC) mainnet or BNB Smart Chain (BSC) mainnet Once you've added the asset to your wallet, you will be able to select different networks to view the assets held by your selected account on that network. @@ -244,7 +244,7 @@ If it's sent to accounts in a different wallet, please * Then you should see your tokens in asset list. ## Why should I use Wallet Direct? -* **Seamless Token Transfer**: Transfer tokens (which support Beacon Chain, BNB Smart Chain and Ethereum) between paired Binance.com account and Binance Extension Wallet. Without the trouble of copy/paste address and memo every time +* **Seamless Token Transfer**: Transfer tokens (which support BNB Beacon Chain, BNB Smart Chain and Ethereum) between paired Binance.com account and Binance Extension Wallet. Without the trouble of copy/paste address and memo every time * **BNB Holding**: The BNB positions of your Binance.com account will not change. diff --git a/docs/fullnodeissue.md b/docs/fullnodeissue.md index 0086a59991..0c7f996094 100644 --- a/docs/fullnodeissue.md +++ b/docs/fullnodeissue.md @@ -114,7 +114,7 @@ Please note that open files are different now. #### Forgot to Upgrade -The Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: +The BNB Beacon Chain has a hardfork upgrade and if you failed to upgrade your fullnode to the latest version, `bnbchaind` process will stop and even if you restart with the latest version, the following error will appear: ``` panic: Tendermint state.AppHash does not match AppHash after replay. Got , expected 393887B67F69B19CAB5C48FB87B4966018ABA893FB3FFD241C0A94D2C8668DD2 goroutine 1 [running]: diff --git a/docs/getting-started.md b/docs/getting-started.md index d67b14c29f..31581fdefd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -5,7 +5,7 @@ sidebar_label: Getting Started This document serve as a starting point for new users to the BNB Chain ecosystem. General knowledge of cryptocurrency is assumed, and in particular familiarity with the Ethereum ecosystem. If you don't understand something right away, that's OK. Search for an answer online, and if you don't find it, ask on our [Discord](http://discord.com/invite/bnbchain). ## What can users do with BNB Smart Chain (BSC)? -BNB Smart Chain (BSC) is the blockchain component of the BNB Chain ecosystem that is equipped with the smart contract functionality and compatibility with the Ethereum Virtual Machine (EVM) and is used for developing various kinds of decentralized applications. The design goal of BSC was to leave the high throughput of Beacon Chain intact while introducing smart contracts into the BNB Chain ecosystem. Being EVM-compatible, other than easy portability, BSC enjoys support of the rich universe of [Ethereum](https://academy.binance.com/en/articles/what-is-ethereum) tools and dApps +BNB Smart Chain (BSC) is the blockchain component of the BNB Chain ecosystem that is equipped with the smart contract functionality and compatibility with the Ethereum Virtual Machine (EVM) and is used for developing various kinds of decentralized applications. The design goal of BSC was to leave the high throughput of BNB Beacon Chain intact while introducing smart contracts into the BNB Chain ecosystem. Being EVM-compatible, other than easy portability, BSC enjoys support of the rich universe of [Ethereum](https://academy.binance.com/en/articles/what-is-ethereum) tools and dApps ### Tokenization On the BNB Smart Chain, users can: @@ -18,7 +18,7 @@ On the BNB Smart Chain, users can: ### BNB Token and Fees BNB is the cryptocurrency coin that powers the BNB Chain ecosystem. As one of the world's most popular utility tokens, not only can you trade BNB like any other cryptocurrency, you can also use BNB in a wide range of applications and use cases. -Although initially based on the Ethereum network, the ERC-20 BNB tokens were later swapped with [BEP-2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md) BNB at a 1:1 ratio. The BEP-2 BNB is the native coin of the Beacon Chain, and the mainnet. +Although initially based on the Ethereum network, the ERC-20 BNB tokens were later swapped with [BEP-2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md) BNB at a 1:1 ratio. The BEP-2 BNB is the native coin of the BNB Beacon Chain, and the mainnet. In 2020, the BNB Smart Chain (BSC) was launched. BSC is a blockchain network that runs in parallel with the BNB Beacon Chain. This means that BNB can be found in three different forms: @@ -55,4 +55,4 @@ BSC empowers developers to build dApps of different kinds. Below is a list of tu ### Node RPC There are data seed nodes in the network which allow users to perform low-level operations like executing ABCI queries, viewing network/consensus state or broadcasting a transaction. -If you run a full node by yourself, you can also use RPC functions. For a list of all the Node RPC services for Beacon Chain refer [here](beaconchain/develop/api-reference/node-rpc.md) and for BNB Smart Chain refer [here](rpc.md). \ No newline at end of file +If you run a full node by yourself, you can also use RPC functions. For a list of all the Node RPC services for BNB Beacon Chain refer [here](beaconchain/develop/api-reference/node-rpc.md) and for BNB Smart Chain refer [here](rpc.md). \ No newline at end of file diff --git a/docs/learn/beaconIntro.md b/docs/learn/beaconIntro.md index a333b79391..3653df0bac 100644 --- a/docs/learn/beaconIntro.md +++ b/docs/learn/beaconIntro.md @@ -4,23 +4,23 @@ sidebar_position: 2 --- # Introduction -Beacon Chain is a blockchain developed by its community that implements the staking and governance layer of BNB ecosystem. It has a flexible set of native assets and pluggable modules for governance, staking and etc. It uses Tendermint for consensus and app logic is built upon Cosmos SDK. It targets fast block times, a native dApp layer and multi-token support with no smart contract VM. +BNB Beacon Chain is a blockchain developed by its community that implements the staking and governance layer of BNB ecosystem. It has a flexible set of native assets and pluggable modules for governance, staking and etc. It uses Tendermint for consensus and app logic is built upon Cosmos SDK. It targets fast block times, a native dApp layer and multi-token support with no smart contract VM. -Beacon Chain implements the following features now: +BNB Beacon Chain implements the following features now: - Sending and receiving BNB and digital assets - Issuing new digital assets (we have a standard called BEP-2 and BEP-8) - Mint/burn, freeze/unfreeze, lock/unlock of digital assets -- Goverenance for beacon chain and side chains +- Goverenance for BNB Beacon Chain and side chains - Staking of side chains - Cross chain transfers and communications -Beacon Chain also includes efforts to implement [listing assets from other chains](../beaconchain/atomic-swap.md), and cryptographic primitives such as [threshold signatures](../beaconchain/learn/threshold-signature-scheme.md). +BNB Beacon Chain also includes efforts to implement [listing assets from other chains](../beaconchain/atomic-swap.md), and cryptographic primitives such as [threshold signatures](../beaconchain/learn/threshold-signature-scheme.md). ## BFT Consensus -[Tendermint Core](https://tendermint.com/core/), which is a Byzantine fault-tolerant (BFT) consensus engine, is adopted in Beacon Chain. +[Tendermint Core](https://tendermint.com/core/), which is a Byzantine fault-tolerant (BFT) consensus engine, is adopted in BNB Beacon Chain. It is robust against double-spend attacks and is tolerant against a set of up to ⅓ (~33%) Byzantine actors in the network. In the protocol, validators take turns proposing blocks of transactions and voting on them. @@ -32,11 +32,11 @@ Currently, there are **11** validators in BNB Beacon Chain mainnet, and more par ## Native Token -BNB is the native token for both BNB Beacon Chain and BNB Smart Chain. On Beacon Chain +BNB is the native token for both BNB Beacon Chain and BNB Smart Chain. On BNB Beacon Chain - BNB is used as the token for staking and goverenance - transactions fees are paid in BNB - transactions burns BNB, according to a fee schedule -- there is a native support for cross chain transfers of BNB between Beacon Chain and side chains. +- there is a native support for cross chain transfers of BNB between BNB Beacon Chain and side chains. ## Security and Finality @@ -44,18 +44,18 @@ BNB is the native token for both BNB Beacon Chain and BNB Smart Chain. On Beacon As mentioned earlier, Tendermint Core is robust against double-spend attacks and is tolerant against a set of up to ⅓ Byzantine actors in the network. Furthermore, Cosmos SDK will also halt if the validators can't come to consensus on a single block to avoid a fork and related attacks. -Beacon Chain guarantees finality on transactions, which means that once agreement is found upon a block, the block becomes final and transactions within that block cannot be reverted. -In summary, **one block finality** is achieved on Beacon Chain, and it usually takes less than **a second**. +BNB Beacon Chain guarantees finality on transactions, which means that once agreement is found upon a block, the block becomes final and transactions within that block cannot be reverted. +In summary, **one block finality** is achieved on BNB Beacon Chain, and it usually takes less than **a second**. ## Governance -Beacon Chain implements a powerful and complex module to govern itself and related side chains (e.g., BSC). +BNB Beacon Chain implements a powerful and complex module to govern itself and related side chains (e.g., BSC). Users can submit different kinds of proposals for signaling, changing consensus parameters on chains, for example, text proposals, fee parameter change proposals, staking parameter change proposals, and so on. For each on-chain proposal, there are deposit period for depositing BNB and voting period for voters to make votes. -Once the proposal passes, it will make effect on Beacon Chain and side chains via cross chain communications. +Once the proposal passes, it will make effect on BNB Beacon Chain and side chains via cross chain communications. ## Participate -There are different ways to participate in the network, from light nodes to full validators. Beacon Chain follows a philosophy of progressive decentralization. We envision a future where organizations and individuals can run validator nodes, and BNB can be staked to join governance. +There are different ways to participate in the network, from light nodes to full validators. BNB Beacon Chain follows a philosophy of progressive decentralization. We envision a future where organizations and individuals can run validator nodes, and BNB can be staked to join governance. diff --git a/docs/learn/bsc-gov.md b/docs/learn/bsc-gov.md index cfd5ed948d..058f3bee4e 100644 --- a/docs/learn/bsc-gov.md +++ b/docs/learn/bsc-gov.md @@ -11,7 +11,7 @@ hide_table_of_contents: false The BSC network is not only a Proof of Staked Authority blockchain network but also one that utilizes on-chain governance. Ideally, such governance logic should be built into the blockchain and automatically executed as the blocking happens. Cosmos Hub, which shares the same Tendermint consensus and libraries with BNB Beacon Chain, works in this way. The BNB Beacon Chain has been preparing to enable governance logic since the design days. In order to keep the compatibility and reuse the good foundation of BC, the governance logic of BSC is implemented on BC. -What kind of changes are made via on-chain governance with BSC? Right now, there are many system parameters to control the behavior of the BSC, e.g. slash amount, cross-chain transfer fees. All these parameters will be determined by BSC Validator Set together through a proposal-vote process based on their staking. Such process will be carried on BC, and the new parameter values will be picked up by either the management module on BC or corresponding system contracts via a cross-chain communication. The proposals can be classified into two groups: 1. Param Change Proposal if the parameter takes effect on the Beacon Chain; 2. Cross Param Change Proposal if the parameter takes effect on the BNB Smart Chain. +What kind of changes are made via on-chain governance with BSC? Right now, there are many system parameters to control the behavior of the BSC, e.g. slash amount, cross-chain transfer fees. All these parameters will be determined by BSC Validator Set together through a proposal-vote process based on their staking. Such process will be carried on BC, and the new parameter values will be picked up by either the management module on BC or corresponding system contracts via a cross-chain communication. The proposals can be classified into two groups: 1. Param Change Proposal if the parameter takes effect on the BNB Beacon Chain; 2. Cross Param Change Proposal if the parameter takes effect on the BNB Smart Chain. To understand process-wise how BSC governance works, it’s best to think of these network upgrades in the following stages which are enforced on the protocol level. @@ -96,7 +96,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | | ------------------- | ------------------------------------------ | ---------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --status | passed | filter proposals by proposal status, status: deposit_period/voting_period/passed/rejected | No | | --voter | bnb1h9ymecpakr8p8lhchtah2xxx7x4xq099umclqu | filter by proposals voted on by voted | No | @@ -114,7 +114,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | | -------------------| ------------------------------------------ | ---------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | @@ -144,7 +144,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | |:-------------------|:-------------------------------------------------------------------|:--------------------------------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | @@ -166,7 +166,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | |:-------------------|:-------------------------------------------------------------------|:--------------------------------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | @@ -187,7 +187,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | |:-------------------|:-------------------------------------------------------------------|:--------------------------------------------------------------------------|:-------------| -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --deposit | 200000000000:BNB | deposit of proposal | Yes | | --from | alice | Name or address of private key with which to sign | Yes | @@ -207,7 +207,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | | -------------------| ------------------------------------------ | ---------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | | --option | Yes | vote option {yes, no, no_with_veto, abstain} | Yes | @@ -225,7 +225,7 @@ Such processes will be carried on BC, and the new parameter values will be picke | **parameter name** | **example** | **comments** | **required** | | -------------------| ------------------------------------------ | ---------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of beacon chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | the id of side chain, default is native chain | Yes | | --proposal-id | 1 | proposalID of proposal being queried | Yes | | --deposit | Yes | amount of deposit | Yes | diff --git a/docs/learn/cross-chain.md b/docs/learn/cross-chain.md index ce65336f4b..76c80a000f 100644 --- a/docs/learn/cross-chain.md +++ b/docs/learn/cross-chain.md @@ -13,10 +13,10 @@ Cross-chain communication is the key foundation to allow the community to take a ## Architecture Diagram ![img](../../static/img/cross-transfer-architecture.png) -A native cross chain communication protocol is developed between BC (Beacon Chain) and BSC (BNB Smart Chain). It has the following key parts: +A native cross chain communication protocol is developed between BC (BNB Beacon Chain) and BSC (BNB Smart Chain). It has the following key parts: * [Build-in System Contract](system-contract.md) -* [Oracle on Beacon Chain](oracle-module.md) +* [Oracle on BNB Beacon Chain](oracle-module.md) * [BSC Relayer](bsc-relayer.md) * [BSC Relayer Incentive Mechanism](incentives.md) * [Oracle Relayer](oracle-relayer.md) diff --git a/docs/learn/ecosystem.md b/docs/learn/ecosystem.md index 76581c56bb..3b48a3047b 100644 --- a/docs/learn/ecosystem.md +++ b/docs/learn/ecosystem.md @@ -44,7 +44,7 @@ In the below sections you can find a list of different layers of the BSC Stack. |API/Node access| [Nodereal](https://nodereal.io/), [Ankr](https://www.ankr.com/), [Chainstack](https://chainstack.com/build-better-with-binance-smart-chain/), [NowNodes](https://nownodes.io/blog/binance-smart-chain-an-introduction), [QuickNode](https://www.quicknode.com/), [Covalent](https://www.covalenthq.com/), [Infstones](https://infstones.com/), [Moralis](http://moralis.io/) | NFT APIs| [NFTScan](https://bnb.nftscan.com/), [BlockVision](https://blockvision.org/), [Venly](https://www.venly.io/), [Gomu](https://www.gomu.co/), [Bounce Finance](https://bounce.finance/), [NFTrade](https://nftrade.com/) |Archive Node Service| [Chainstack](https://chainstack.com/build-better-with-binance-smart-chain/), [InfStones](https://infstones.com/), [QuickNode](https://www.quicknode.com/), [Nodereal’s Meganode](https://docs.nodereal.io/nodereal/meganode/archive-node) -|Public RPC Endpoints| [RPC Endpoints](https://docs.binance.org/smart-chain/developer/rpc.html)| More public nodes are encouraged +|Public RPC Endpoints| [RPC Endpoints](https://docs.bnbchain.org/smart-chain/developer/rpc.html)| More public nodes are encouraged |Community Polling Dashboard| | |Gas Station Network| [opengsn](https://opengsn.org/) |Faucet| [BSC Test Faucet](https://testnet.binance.org/faucet-smart) @@ -61,7 +61,7 @@ In the below sections you can find a list of different layers of the BSC Stack. | IDEs | [BSC Studio](https://github.com/ObsidianLabs/BSC-Studio),[Remix](https://remix.ethereum.org/),[Intellij Solidity Plugin](https://jetbrains.com/idea/), [ChainIDE](https://eth.chainide.com/project/welcome) | Lint Tools | [Solhint](https://github.com/protofire/solhint), [Ethlint](https://github.com/duaraghav8/Ethlint), [Manticore](https://github.com/trailofbits/manticore), [Slither](https://github.com/crytic/slither), [Echidna](https://github.com/crytic/echidna) | Testing Tools | [Solidity code coverage](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-coverage), [Solidity function profiler](https://github.com/EricR/sol-function-profiler), [eth-tester](https://github.com/ethereum/eth-tester) -| Test blockchain networks | [bscnode](https://docs.binance.org/smart-chain/developer/fullnode.html), [Ganache](https://github.com/trufflesuite/ganache) +| Test blockchain networks | [bscnode](https://docs.bnbchain.org/smart-chain/developer/fullnode.html), [Ganache](https://github.com/trufflesuite/ganache) | Security tools | [MythX](https://mythx.io/), [Mythril](https://github.com/ConsenSys/mythril), [Oyente](https://github.com/melonproject/oyente), [Securify](https://securify.chainsecurity.com/), [Solgraph](https://github.com/raineorshine/solgraph), [solc-verify](https://github.com/SRI-CSL/solidity/) | ABI (Application Binary Interface) tools | [ABI decoder](https://github.com/ConsenSys/abi-decoder), [ABI-gen](https://github.com/0xProject/0x-monorepo/tree/development/packages/abi-gen), [Ethereum ABI UI](https://github.com/hiddentao/ethereum-abi-ui) | Monitoring | [Neufund - Smart Contract Watch](https://github.com/Neufund/smart-contract-watch), [BlockScout](https://github.com/poanetwork/blockscout), [Terminal](https://terminal.co/), [Ethereum-watcher](https://github.com/HydroProtocol/ethereum-watcher) diff --git a/docs/learn/incentives.md b/docs/learn/incentives.md index 40a26c98f7..86328b922c 100644 --- a/docs/learn/incentives.md +++ b/docs/learn/incentives.md @@ -1,7 +1,7 @@ # Incentive Mechanism The BSC relayers play an important role in relaying interchain packages from BC to BSC. -All BSC relayers build their stable infrastructure, watch any event happened on the Beacon Chain, and act timely to get paid accordingly. The following discussion is about how to distribute the rewards to let the relayers are willing to make a long-term contribution. +All BSC relayers build their stable infrastructure, watch any event happened on the BNB Beacon Chain, and act timely to get paid accordingly. The following discussion is about how to distribute the rewards to let the relayers are willing to make a long-term contribution. ## Principle Considering the following points: @@ -55,7 +55,7 @@ To prevent the relayer who has the best network always winning the game, we gath 1. S to be 100. Some rewards come from gas fee, we can not guarantee enough rewards during a small round, a large round may dismiss deviation and let relayer give up relaying when it has made its max profit. 2. N to be 40. We think the redundancy of relayer around 3-5 is best. If N is too large, the redundancy will decrease. If N is too small, then there will not be enough relayers. Set N as 40 may be a reasonable value, at least 3 relayers can compete. -3. The relayFee of a single package and the ratio of reward for header relayer can be modified by governance on Beacon Chain. +3. The relayFee of a single package and the ratio of reward for header relayer can be modified by governance on BNB Beacon Chain. ### Distribution And Claim Reward @@ -78,6 +78,6 @@ Block header sync transaction with `validatorSet` change will claim reward to re For example, a relayer may deliver packages using a different address in round robin, we can’t recognize this. We try to introduce registration and BNB deposit for relayer to raise the cost of cheat. How it works: * A BSC account needs to call the `register` of [RelayerHub](https://bscscan.com/address/0x0000000000000000000000000000000000001006) contract to deposit 100BNB(more or less than 100 BNB will be rejected) to become a BSC relayer. -* Only a valid relayer can sync Beacon Chain Headers and deliver cross-chain packages. +* Only a valid relayer can sync BNB Beacon Chain Headers and deliver cross-chain packages. * Relayer can withdraw its deposit, but we will charge 0.1 BNB as the transaction fee so that it will receive 99.9 BNB back. * The charged fee will directly go to the system reward pool. diff --git a/docs/learn/intro.md b/docs/learn/intro.md index d1be2eb469..46b0f8ccd0 100644 --- a/docs/learn/intro.md +++ b/docs/learn/intro.md @@ -6,12 +6,12 @@ hide_table_of_contents: false # Introduction -BNB Smart Chain is an innovative solution to bring programmability and interoperability to Beacon Chain. BNB Smart Chain relies on a system of 50 validators with Proof of Staked Authority (PoSA) consensus that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection, malicious vote detection and other slashing logic guarantee security, stability, and chain finality. +BNB Smart Chain is an innovative solution to bring programmability and interoperability to BNB Beacon Chain. BNB Smart Chain relies on a system of 50 validators with Proof of Staked Authority (PoSA) consensus that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection, malicious vote detection and other slashing logic guarantee security, stability, and chain finality. Other than the 29 active validators, BSC will introduce more validators, e.g. another 20 inactive validators, into the validator set as backups, which will be called "Candidates". Candidates will produce blocks and charge gas fees in BSC mainnet, but in a much less chance than the official validator set of 29 elected. The unavailable candidates will be slashed as well though in a smaller size. A decent motivation is expected to be maintained so that the candidate validators are willing to ensure the quality and help secure BSC. -In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to Beacon Chain about the stale blocking, resume it and eventually propose a re-election of the active validator set. +In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to BNB Beacon Chain about the stale blocking, resume it and eventually propose a re-election of the active validator set. The BNB Smart Chain also supports EVM-compatible smart contracts and protocols. Cross-chain transfer and other communication are possible due to native support of interoperability. The BNB Smart Chain will be: diff --git a/docs/learn/oracle-module.md b/docs/learn/oracle-module.md index 44420dd067..64c8145290 100644 --- a/docs/learn/oracle-module.md +++ b/docs/learn/oracle-module.md @@ -4,7 +4,7 @@ sidebar_position: 2 hide_table_of_contents: false --- -# Oracle on Beacon Chain +# Oracle on BNB Beacon Chain The **oracle** module is a common module like gov which is used to handle prophecy and claim. Prophecy means the validators want to reach a consensus on something, like cross chain transfer. Claim is raised by a validator and the content of claim is the cross chain transfer. When most of the validators (like 70%) claim the same thing on the prophecy, the winning claim will be executed.For oracle module is a common module, other module which depends on oracle module will register claim type and related hooks checking and handling claim. Each claim type has a sequence, oracle module should process prophecy and claim by sequence. When one prophecy is executed successfully, the sequence of the claim type will be increased by one. diff --git a/docs/learn/system-contract.md b/docs/learn/system-contract.md index f3d0690f62..d83b0cbc44 100644 --- a/docs/learn/system-contract.md +++ b/docs/learn/system-contract.md @@ -25,7 +25,7 @@ GitHub Implementation link: ## On-Chain Light Client -The purpose of cross-chain interoperability is to enable one blockchain to function as a light-client of another. Since Beacon Chain is using a classical Byzantine Fault Tolerant consensus algorithm, light-client verification is cheap and easy: all we have to do is check validator signatures on the latest block, and verify a Merkle proof of the state. +The purpose of cross-chain interoperability is to enable one blockchain to function as a light-client of another. Since BNB Beacon Chain is using a classical Byzantine Fault Tolerant consensus algorithm, light-client verification is cheap and easy: all we have to do is check validator signatures on the latest block, and verify a Merkle proof of the state. In Tendermint, validators agree on a block before processing it. This means that the signatures and state root for that block aren't included until the next block. Thus, each block contains a field called LastCommit, which contains the votes responsible for committing the previous block, and a field in the block header called AppHash, which refers to the Merkle root hash of the application after processing the transactions from the previous block. So, if we want to verify the AppHash from height H, we need the signatures from LastCommit at height H+1. (And remember that this AppHash only contains the results from all transactions up to and including block H-1) @@ -60,7 +60,7 @@ This contract implements a [Tendermint merkle proof verification algorithm](http * **BSCValidatorSet Contract** - It is a watcher of validators change of BSC on Beacon Chain. It will interact with light client contracts to verify the interchain transaction, and apply the validator set change for BSC. It also stores rewarded gas fee of blocking for validators, and distribute it to validators when receiving cross chain package of validatorSet change. + It is a watcher of validators change of BSC on BNB Beacon Chain. It will interact with light client contracts to verify the interchain transaction, and apply the validator set change for BSC. It also stores rewarded gas fee of blocking for validators, and distribute it to validators when receiving cross chain package of validatorSet change. * **System Reward Contract** diff --git a/docs/migration/evm-chains/chain-comparison.md b/docs/migration/evm-chains/chain-comparison.md index dbabaa8213..043bdb9b82 100644 --- a/docs/migration/evm-chains/chain-comparison.md +++ b/docs/migration/evm-chains/chain-comparison.md @@ -11,8 +11,8 @@ Ethereum is regarded as the pioneer public blockchain to offer smart contract pr EVM-compatibility can be regarded as a stepping stone for achieving blockchain interoperability. EVM-compatibility means creating an EVM-like code execution environment that makes it easy for Ethereum developers to migrate smart contracts to an EVM compatible chain without having to write the code from scratch again. So, developers can conveniently migrate their dApps from the Ethereum network to BSC or other EVM-compatible networks. Some of the major EVM chains include BSC, Polygon, Avalanche, etc. ### BNB Chain -The BNB Chain ecosystem comprises two blockchain giants, namely, Beacon Chain (BC) and the BNB Smart Chain (BSC). The Beacon Chain is responsible for the Governance of the BNB Chain, offering services such as (staking and voting. Whereas the BNB Smart Chain (BSC) blockchain, founded in 2020, is an EVM compatible blockchain and contains consensus layers and hubs to multi-chains. -BSC is an improved Ethereum's hard fork and runs parallel to the Beacon Chain. BSC offers smart contract functionality to the BNB Chain ecosystem and is a platform for creating DeFi, Gaming, Social and other DApps. BSC gained real popularity in early 2021 because of its lower gas fees and faster finality as compared to Ethereum's high gas fees and scalability problems. +The BNB Chain ecosystem comprises two blockchain giants, namely, BNB Beacon Chain (BC) and the BNB Smart Chain (BSC). The BNB Beacon Chain is responsible for the Governance of the BNB Chain, offering services such as (staking and voting. Whereas the BNB Smart Chain (BSC) blockchain, founded in 2020, is an EVM compatible blockchain and contains consensus layers and hubs to multi-chains. +BSC is an improved Ethereum's hard fork and runs parallel to the BNB Beacon Chain. BSC offers smart contract functionality to the BNB Chain ecosystem and is a platform for creating DeFi, Gaming, Social and other DApps. BSC gained real popularity in early 2021 because of its lower gas fees and faster finality as compared to Ethereum's high gas fees and scalability problems. ### Polygon Polygon, formerly known as Matic, is a Layer-2 scaling solution for the Ethereum Blockchain. It addresses some of the Ethereum fallbacks by utilizing sidechains, achieving similar decentralization and security of the Ethereum Network. It essentially addresses the issues inherent to the Ethereum blockchain’s scalability and consensus algorithm for speeding up the transactions per second (or TPS). @@ -31,7 +31,7 @@ Support for the EVM allows interoperability between BSC, Polygon Network, and th ### Architecture #### Overview of BSC’s Architecture -BNB Chain is an ecosystem comprising of two major blockchains that serve different purposes, namely, Beacon Chain (BC) and BNB Smart Chain (BSC). To deal with the increased volumes of transactions and daily active users (DAU), BNB Chain ecosystem has evolved to add more scaling solutions and now includes the following components with different responsibilities and purposes. +BNB Chain is an ecosystem comprising of two major blockchains that serve different purposes, namely, BNB Beacon Chain (BC) and BNB Smart Chain (BSC). To deal with the increased volumes of transactions and daily active users (DAU), BNB Chain ecosystem has evolved to add more scaling solutions and now includes the following components with different responsibilities and purposes. 1. [BNB Beacon Chain](https://docs.bnbchain.org/docs/learn/beaconIntro) - BNB Chain Governance (staking, voting) 2. [BNB Smart Chain (BSC)](https://docs.bnbchain.org/docs/learn/intro) - EVM compatible, consensus layers, and with hubs to multi-chains 3. [ZkBNB](https://docs.bnbchain.org/docs/zkbnb/zkbnb-overview)- ZkRollup solution to scale BSC as a super high-performance blockchain. @@ -39,7 +39,7 @@ BNB Chain is an ecosystem comprising of two major blockchains that serve differe ![bnb-chain-ecosystem](./BNBChain2022.png) The design principles of **BSC**: -1. **Standalone Blockchain:** even though BSC can be termed as a Layer-2 solution to Beacon Chain, technically, it is a standalone blockchain. Most of the fundamental technical and business functions of BSC are self-contained and it can run well even if the BC is stopped. +1. **Standalone Blockchain:** even though BSC can be termed as a Layer-2 solution to BNB Beacon Chain, technically, it is a standalone blockchain. Most of the fundamental technical and business functions of BSC are self-contained and it can run well even if the BC is stopped. 2. **Ethereum Compatibility:** To take advantage of the mature applications and community of Ethereum, BSC chooses to be compatible with the existing Ethereum mainnet. This means all of the dApps, ecosystem components, and toolings work with BSC and require zero or minimum changes. Furthermore, BSC nodes require similar (or a bit higher) hardware specification and skills to run and operate. 3. **Staking Involved Consensus and Governance:** Staking-based consensus is more environmentally friendly and leaves more flexible options to community governance. Expectedly, this consensus enables better network performance over proof-of-work blockchain systems, i.e., faster blocking time and higher transaction capacity. 4. **Native Cross-Chain Communication:** both BC and BSC are implemented with native support for cross-chain communication among the two blockchains. The communication protocol is designed to be bi-directional, decentralized, and trustless. It concentrates on moving digital assets between BC and BSC, i.e., BEP2 tokens, and eventually, any other BEP tokens introduced later. @@ -88,7 +88,7 @@ Polygon utilizes the **Proof-of-Stake (PoS)** consensus algorithm, whereas BSC e In the PoS consensus algorithm, validators are chosen based on a user's commitment to the network in terms of its stake, meaning that the higher the stake, higher the chances of getting selected as a validator. On the other hand, **PoSA** is a combination of the **PoS** and the **PoA (Proof of Authority)** consensus mechanisms. -Utilizing the PoSA consensus mechanism, BSC was initially launched with **21** validators. However, now BSC supports a set of **44** validators, with **26** of them being active. In future, BSC plans to increase the active validators to **41**, and about **80-100** validators in total. The top validator candidates with the most bonded stakes are chosen to be part of the subset of active validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. Other than the **41 active validators**, BSC also has a set of inactive validators known as the **Candidates**. Even though the chances of getting elected are less, the Candidates upon selection can produce blocks and charge gas fees in the BSC mainnet. Similar to Active Validators, unavailable candidates are slashed but for a smaller amount. In an extreme case, if a majority of the active 41 validators get attacked and offline, Candidate Validators can report to Beacon Chain about the stale blocking, resume it and eventually propose re-election of the active validator set. +Utilizing the PoSA consensus mechanism, BSC was initially launched with **21** validators. However, now BSC supports a set of **44** validators, with **26** of them being active. In future, BSC plans to increase the active validators to **41**, and about **80-100** validators in total. The top validator candidates with the most bonded stakes are chosen to be part of the subset of active validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. Other than the **41 active validators**, BSC also has a set of inactive validators known as the **Candidates**. Even though the chances of getting elected are less, the Candidates upon selection can produce blocks and charge gas fees in the BSC mainnet. Similar to Active Validators, unavailable candidates are slashed but for a smaller amount. In an extreme case, if a majority of the active 41 validators get attacked and offline, Candidate Validators can report to BNB Beacon Chain about the stale blocking, resume it and eventually propose re-election of the active validator set. In contrast, Polygon uses the **Proof-of-Stake (PoS)** consensus mechanism on its _Plasma/POS commit chains_. For any user willing to participate in the consensus process, users are required to stake MATIC tokens on the staking smart contracts on Ethereum mainnet. This staking indicates a user's commitment to the process. A slashing mechanism (removal of staked funds) is also implemented to discourage stakers from submitting invalid blocks, illegally verifying blocks, or executing invalid transactions. Requiring validators to put funds at risk before they can participate in consensus helps maintain the integrity of the network. diff --git a/docs/migration/evm-chains/token-comparison.md b/docs/migration/evm-chains/token-comparison.md index cd802d843b..1b1546fcc6 100644 --- a/docs/migration/evm-chains/token-comparison.md +++ b/docs/migration/evm-chains/token-comparison.md @@ -27,7 +27,7 @@ Furthermore, token standards are designed to help avoid fraud, technical incompa One of the most popular token standards is the ERC standard. ERC (Ethereum Request for Comments) is a set of rules defining the issuance and implementation of tokens on the Ethereum Blockchain. ERC20 is a technical standard that describes a common set of rules that should be followed for a token to function properly within the Ethereum ecosystem. It is one of the most commonly used standards and is usually used for fungible tokens in the form of cryptocurrencies. Other popular ERC standards are ERC-721 (NFTs) and ERC-1155 Multi-Token Standard. ### BEP Token Standard -Similar to ERC, BNB Chain defines its own set of standards for token issuance, management, and implementation known as BEP (BNB Evolution Proposals). BEPs are token management rules and pre-defined criteria for launching on-chain assets on BNB Chain. The most popular BEP standards are BEP2 and BEP20. BEP2 is the native coin of the Beacon Chain. Whereas BEP20 is popular for use on BSC. It is to note here that BEP20 is very similar to ERC20 and extends its functionality. Note that BNB, which is the native token of the BNB Chain ecosystem, is a BEP2 token. +Similar to ERC, BNB Chain defines its own set of standards for token issuance, management, and implementation known as BEP (BNB Evolution Proposals). BEPs are token management rules and pre-defined criteria for launching on-chain assets on BNB Chain. The most popular BEP standards are BEP2 and BEP20. BEP2 is the native coin of the BNB Beacon Chain. Whereas BEP20 is popular for use on BSC. It is to note here that BEP20 is very similar to ERC20 and extends its functionality. Note that BNB, which is the native token of the BNB Chain ecosystem, is a BEP2 token. ### Difference between ERC and BEP tokens Both ERC20 and BEP20 standards are very similar in mechanism. However, ERC-20 is dedicated to Ethereum, whereas BEP-20 is dedicated to BNB Smart Chain. In simpler terms, each of these is a token standard that belongs to a different blockchain. @@ -44,12 +44,12 @@ In this section, we provide a brief difference between the ERC20 and BEP20 token ## Token Standards Supported by BSC -BNB Chain is an ecosystem that runs on two blockchain giants, namely, Beacon Chain (BC) and BNB Smart Chain (BSC). The native token standard for Beacon Chain is BEP2, while the native token standard for BNB Smart Chain is BEP20. BNB ecosystem’s native currency, BNB, initially launched as an ERC20 token, is in fact a BEP2 token. +BNB Chain is an ecosystem that runs on two blockchain giants, namely, BNB Beacon Chain (BC) and BNB Smart Chain (BSC). The native token standard for BNB Beacon Chain is BEP2, while the native token standard for BNB Smart Chain is BEP20. BNB ecosystem’s native currency, BNB, initially launched as an ERC20 token, is in fact a BEP2 token. ### BEP2 Tokens -Beacon Chain is essentially a digital asset creation and exchange platform. Beacon chain is responsible for the governance of the BNB Chain ecosystem, which includes staking and voting. BEP2 is the token standard for BNB Chain's native currency, BNB, on Binance's crypto exchanges. It is a unique token standard. BEP2 is not compatible with blockchains other than BNB Chain. Additionally, BNB in the BEP2 format can only be used as a transaction fee on both Binance cryptocurrency exchanges. One limitation of BEP2 is its lack of support for smart contract development. For more information, you can read the full BEP2 proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). +BNB Beacon Chain is essentially a digital asset creation and exchange platform. BNB Beacon Chain is responsible for the governance of the BNB Chain ecosystem, which includes staking and voting. BEP2 is the token standard for BNB Chain's native currency, BNB, on Binance's crypto exchanges. It is a unique token standard. BEP2 is not compatible with blockchains other than BNB Chain. Additionally, BNB in the BEP2 format can only be used as a transaction fee on both Binance cryptocurrency exchanges. One limitation of BEP2 is its lack of support for smart contract development. For more information, you can read the full BEP2 proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). ### BEP20 Tokens -BSC is the blockchain component of the BNB Chain that provides its users with a smart contract facility and is a platform for dApp development. BEP20 is a token interface standard for creating token contracts on BSC. The BEP20 tokens are designed to be compatible with BEP2 and [ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 for compatibility with EVM chain and Ethereum smart contracts. Other than the ERC20 functionalities, the BEP20 standard contains additional interfaces, such as getOwner and decimals. For more information on BEP20, read the full proposal [here](https://github.com/binance-chain/BEPs/blob/master/BEP20.md). +BSC is the blockchain component of the BNB Chain that provides its users with a smart contract facility and is a platform for dApp development. BEP20 is a token interface standard for creating token contracts on BSC. The BEP20 tokens are designed to be compatible with BEP2 and [ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 for compatibility with EVM chain and Ethereum smart contracts. Other than the ERC20 functionalities, the BEP20 standard contains additional interfaces, such as getOwner and decimals. For more information on BEP20, read the full proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP20.md). diff --git a/docs/migration/non-evm-chains/solana/architecture-comparison.md b/docs/migration/non-evm-chains/solana/architecture-comparison.md index bce1c5833a..9a9e90e498 100644 --- a/docs/migration/non-evm-chains/solana/architecture-comparison.md +++ b/docs/migration/non-evm-chains/solana/architecture-comparison.md @@ -11,7 +11,7 @@ This document covers the architectural differences between BNB Chain and Solana Ethereum is considered the pioneer of blockchain platforms offering developers the option of developing decentralized applications (dApps) through the use of smart contracts. However, with obstacles like high gas cost and scalability issues, several other blockchain platforms offering better features to users have emerged. Amongst the most popular Layer-1 blockchains are BNB Chain and Solana. -BNB Chain has since garnered immense popularity and is now the largest smart contract-powered blockchain network as it provides users with speed, security, scalability, and innovative features. BNB Chain comprises two parts, the Beacon Chain (BC) and the BNB Smart Chain (BSC). BSC offers dApp development, is Ethereum Virtual Machine (EVM) compatible and uses the EVM for smart contract execution. This means that all of the tools and infrastructure compatible with the Ethereum network can also be used with the BSC network. Also, porting projects onto BSC from other EVM-based chains is possible. +BNB Chain has since garnered immense popularity and is now the largest smart contract-powered blockchain network as it provides users with speed, security, scalability, and innovative features. BNB Chain comprises two parts, the BNB Beacon Chain (BC) and the BNB Smart Chain (BSC). BSC offers dApp development, is Ethereum Virtual Machine (EVM) compatible and uses the EVM for smart contract execution. This means that all of the tools and infrastructure compatible with the Ethereum network can also be used with the BSC network. Also, porting projects onto BSC from other EVM-based chains is possible. On the other hand, one of the most popular non-EVM-based blockchain networks is the Solana blockchain. By being non-EVM based, this means that Solana has its own set of token standards, dev tools, infrastructure, etc., for dApp development. This also means that the majority of the Ethereum-compliant tools and standards cannot be used on the Solana network. Solana initially gained good traction in the Web3 ecosystem, though it also faced incidents of non-availability, scalability, and security issues, leading some projects to consider other options available in the market such as BNB Chain. @@ -23,9 +23,9 @@ In this section, we provide an introductory overview of both of the blockchain g ### BNB Chain -The BNB Chain ecosystem comprises two blockchain giants, namely, Beacon Chain (BC) and the BNB Smart Chain (BSC). The Beacon Chain is responsible for the Governance of the BNB Chain (Staking, Voting). Whereas, the BNB Smart Chain (BSC) blockchain, founded in 2020, is EVM compatible and contains consensus layers and hubs to multi-chains. The BNB Token is the native cryptocurrency of the ecosystem that is used for both staking purposes as well as for payments of transactions over the network. +The BNB Chain ecosystem comprises two blockchain giants, namely, BNB Beacon Chain (BC) and the BNB Smart Chain (BSC). The BNB Beacon Chain is responsible for the Governance of the BNB Chain (Staking, Voting). Whereas, the BNB Smart Chain (BSC) blockchain, founded in 2020, is EVM compatible and contains consensus layers and hubs to multi-chains. The BNB Token is the native cryptocurrency of the ecosystem that is used for both staking purposes as well as for payments of transactions over the network. -BSC runs parallel to the Beacon Chain and is the EVM-compatible component of the BNBChain ecosystem, and offers smart contract functionality for creating dApps and other blockchain-based products. BSC gained real popularity in early 2021 because of its lower gas fees and faster finality as compared to Ethereum's high gas fees and scalability problems. BSC uses the Proof-of-Staked-Authority (PoSA) consensus algorithm i.e, it merges delegated Proof-of-Stake with Proof-of-Authority (PoA). +BSC runs parallel to the BNB Beacon Chain and is the EVM-compatible component of the BNBChain ecosystem, and offers smart contract functionality for creating dApps and other blockchain-based products. BSC gained real popularity in early 2021 because of its lower gas fees and faster finality as compared to Ethereum's high gas fees and scalability problems. BSC uses the Proof-of-Staked-Authority (PoSA) consensus algorithm i.e, it merges delegated Proof-of-Stake with Proof-of-Authority (PoA). ### Solana @@ -37,7 +37,7 @@ In this section, we provide a brief overview of the architecture of both BSC and ### BSC Architecture Overview -BNB Chain is an ecosystem comprising two major blockchains that serve different purposes, namely, Beacon Chain (BC) and BNB Smart Chain (BSC). To deal with the increased transactions and DAU, the BNB Chain ecosystem has evolved to add more scaling solutions and now comprises the following components with different responsibilities and purposes. +BNB Chain is an ecosystem comprising two major blockchains that serve different purposes, namely, BNB Beacon Chain (BC) and BNB Smart Chain (BSC). To deal with the increased transactions and DAU, the BNB Chain ecosystem has evolved to add more scaling solutions and now comprises the following components with different responsibilities and purposes. - [**BNB Beacon Chain**](https://docs.bnbchain.org/docs/learn/beaconIntro) - BNB Chain Governance (Staking, Voting) - [**BNB Smart Chain (BSC)**](https://docs.bnbchain.org/docs/learn/intro) - EVM compatible, consensus layers, and with hubs to multi-chains @@ -47,10 +47,10 @@ BNB Chain is an ecosystem comprising two major blockchains that serve different #### Design principles of BSC -- **Standalone Blockchain**: even though BSC runs in parallel to the Beacon chain, technically, it is a standalone blockchain. Most of the fundamental technical and business functions of BSC are self-contained, and it can run well even if the BC is stopped. +- **Standalone Blockchain**: even though BSC runs in parallel to the BNB Beacon Chain, technically, it is a standalone blockchain. Most of the fundamental technical and business functions of BSC are self-contained, and it can run well even if the BC is stopped. - **Ethereum Compatibility**: To take advantage of the relatively mature applications and community of Ethereum, BSC chooses to be compatible with the existing Ethereum mainnet. This means most of the Ethereum-based **dApps**, ecosystem components, and toolings work with BSC and require zero or minimum changes. Furthermore, BSC nodes require similar (or a bit higher) hardware specifications and skills to run and operate. - **Staking Involved Consensus and Governance**: Staking-based consensus is more environmentally friendly and leaves more flexible options for community governance. Expectedly, this consensus enables better network performance over[ proof-of-work](https://en.wikipedia.org/wiki/Proof_of_work) blockchain systems, i.e., faster blocking time and higher transaction capacity. -- **Native Cross-Chain Communication**: both BC and BSC are implemented with native support for cross-chain communication among the two blockchains. The communication protocol is designed to be bi-directional, decentralized, and trustless. It concentrates on moving digital assets between BC and BSC, i.e.,[ BEP2](https://github.com/binance-chain/BEPs/blob/master/BEP2.md) tokens, and eventually, any other BEP tokens introduced later. +- **Native Cross-Chain Communication**: both BC and BSC are implemented with native support for cross-chain communication among the two blockchains. The communication protocol is designed to be bi-directional, decentralized, and trustless. It concentrates on moving digital assets between BC and BSC, i.e.,[ BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md) tokens, and eventually, any other BEP tokens introduced later. ![image](https://user-images.githubusercontent.com/93580180/201683059-ef7983fa-6828-4c66-a87c-bf62ba4456b9.png) diff --git a/docs/migration/non-evm-chains/solana/token-migration.md b/docs/migration/non-evm-chains/solana/token-migration.md index ba2ec0de3f..d194cdc27b 100644 --- a/docs/migration/non-evm-chains/solana/token-migration.md +++ b/docs/migration/non-evm-chains/solana/token-migration.md @@ -36,7 +36,7 @@ One of the most widely used token standards is the ERC standard. Ethereum Reques #### BEP Token Standard -Similarly to ERC, BNB Chain defines its own set of standards for token issuance, management, and implementation known as BEP (BNB Chain Evolution Proposals). BEPs are token management rules and pre-defined criteria for launching on-chain assets on BNB Chain. The most popular BEP standards are BEP2 and BEP20. BEP2 is the native coin of the Beacon Chain. Whereas, BEP20 is popular for use on BSC. It is to note here that BEP20 is very similar to ERC20 and extends its functionality. Note that, BNB which is the native token of the BNB Chain ecosystem, is also a BEP20 token. +Similarly to ERC, BNB Chain defines its own set of standards for token issuance, management, and implementation known as BEP (BNB Chain Evolution Proposals). BEPs are token management rules and pre-defined criteria for launching on-chain assets on BNB Chain. The most popular BEP standards are BEP2 and BEP20. BEP2 is the native coin of the BNB Beacon Chain. Whereas, BEP20 is popular for use on BSC. It is to note here that BEP20 is very similar to ERC20 and extends its functionality. Note that, BNB which is the native token of the BNB Chain ecosystem, is also a BEP20 token. #### SPL Token Standard @@ -47,15 +47,15 @@ Famous for its parallel execution engine, the Solana blockchain was launched in ### Token Standards Supported by BSC -BNB Chain is an ecosystem that runs on two blockchain giants, namely, Beacon Chain (BC) and BNB Smart Chain (BSC). The native token standard for Beacon Chain is BEP2, while the native token standard for BNB Smart Chain is BEP-20. BNB Ecosystem's native currency, BNB, initially launched as an ERC20 token, is a BEP2 token. +BNB Chain is an ecosystem that runs on two blockchain giants, namely, BNB Beacon Chain (BC) and BNB Smart Chain (BSC). The native token standard for BNB Beacon Chain is BEP2, while the native token standard for BNB Smart Chain is BEP-20. BNB Ecosystem's native currency, BNB, initially launched as an ERC20 token, is a BEP2 token. #### BEP2 Tokens -The beacon chain is responsible for the governance of the BNB Chain ecosystem which includes staking and voting. BEP2 is the token standard for BNB Chain's native currency, BNB, on Binance's crypto exchanges. It is a unique token standard, BEP2 is not compatible with blockchains other than BNB Chain. Additionally, BNB in the BEP2 format can only be used as a transaction fee on both Binance cryptocurrency exchanges. One limitation of BEP2 is its lack of support for smart contract development. For more information, you can read the full BEP2 proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). +The BNB Beacon Chain is responsible for the governance of the BNB Chain ecosystem which includes staking and voting. BEP2 is the token standard for BNB Chain's native currency, BNB, on Binance's crypto exchanges. It is a unique token standard, BEP2 is not compatible with blockchains other than BNB Chain. Additionally, BNB in the BEP2 format can only be used as a transaction fee on both Binance cryptocurrency exchanges. One limitation of BEP2 is its lack of support for smart contract development. For more information, you can read the full BEP2 proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). #### BEP20 Tokens -BSC is the blockchain component of the BNB Chain that provides its users with a smart contract facility and is a platform for dApp development. BEP20 is a token interface standard for creating token contracts on BSC. The BEP20 tokens are designed to be compatible with BEP2 and[ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 for compatibility with EVM chain and Ethereum smart contracts. Other than the ERC20 functionalities, the BEP20 standard contains additional interfaces, such as getOwner and decimals. For more information on BEP20, read the full proposal [here](https://github.com/binance-chain/BEPs/blob/master/BEP20.md). +BSC is the blockchain component of the BNB Chain that provides its users with a smart contract facility and is a platform for dApp development. BEP20 is a token interface standard for creating token contracts on BSC. The BEP20 tokens are designed to be compatible with BEP2 and[ERC20](https://eips.ethereum.org/EIPS/eip-20). It extends ERC20 for compatibility with EVM chain and Ethereum smart contracts. Other than the ERC20 functionalities, the BEP20 standard contains additional interfaces, such as getOwner and decimals. For more information on BEP20, read the full proposal [here](https://github.com/bnb-chain/BEPs/blob/master/BEP20.md). ## Token migration diff --git a/docs/mirror.md b/docs/mirror.md index 7d86f82736..3eea47e6d4 100644 --- a/docs/mirror.md +++ b/docs/mirror.md @@ -18,7 +18,7 @@ Anyone can call the `mirror` [method](https://github.com/bnb-chain/bsc-genesis-c - Verify there is no pending mirror request - Check the total supply and token symbol is valid -- Send a cross-chain package to issue a BEP2 token on Beacon Chain +- Send a cross-chain package to issue a BEP2 token on BNB Beacon Chain - The newly created BEP2 token is locked until the token holder send cross-chain transfer After binding, all liquid circulation is on BSC. diff --git a/docs/more-help.md b/docs/more-help.md index 8862ddfe94..e5c438662f 100644 --- a/docs/more-help.md +++ b/docs/more-help.md @@ -6,7 +6,7 @@ There is a [\#validator-support](http://discord.com/invite/bnbchain) Discord cha - Main portal to get community support is our [Online Forum](https://www.buildnbuild.dev). -- To keep track of the latest news in Beacon Chain/DEX, visit [Online Forum](https://www.buildnbuild.dev/). +- To keep track of the latest news in BNB Beacon Chain/DEX, visit [Online Forum](https://www.buildnbuild.dev/). - Network Explorer - [BSCScan Explorer](https://bscscan.com/) diff --git a/docs/stake/Staking.md b/docs/stake/Staking.md index bcad79a8b5..ef7be6c98b 100644 --- a/docs/stake/Staking.md +++ b/docs/stake/Staking.md @@ -6,11 +6,11 @@ hide_table_of_contents: false # Staking -[BNB Smart Chain](https://community.binance.org/topic/2686) is an innovative solution to bring programmability and interoperability to [Beacon Chain](https://www.binance.org). BNB Smart Chain relies on a system of 50 validators with Proof of [Staked Authority (PoSA) consensus](../learn/consensus.md) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. +[BNB Smart Chain](https://community.binance.org/topic/2686) is an innovative solution to bring programmability and interoperability to [BNB Beacon Chain](https://www.binance.org). BNB Smart Chain relies on a system of 50 validators with Proof of [Staked Authority (PoSA) consensus](../learn/consensus.md) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. -Ideally, BNB Smart Chain should build such staking and reward logic into the blockchain, and automatically distribute rewards as the blocking happens. [Cosmos Hub](https://hub.cosmos.network/), who also build on top of Tendermint consensus like Beacon Chain, works in this way. +Ideally, BNB Smart Chain should build such staking and reward logic into the blockchain, and automatically distribute rewards as the blocking happens. [Cosmos Hub](https://hub.cosmos.network/), who also build on top of Tendermint consensus like BNB Beacon Chain, works in this way. -However, as BSC wants to remain compatible with Ethereum as much as possible. On the other side, Beacon Chain already has a staking module and could be extended to support both BC and BSC. In this way, all the staking related operations are recorded in BC. Once there are any changes about BSC's validator set or voting power, the new message will be transferred to BSC through cross-chain communication. +However, as BSC wants to remain compatible with Ethereum as much as possible. On the other side, BNB Beacon Chain already has a staking module and could be extended to support both BC and BSC. In this way, all the staking related operations are recorded in BC. Once there are any changes about BSC's validator set or voting power, the new message will be transferred to BSC through cross-chain communication. ## Staking Economics diff --git a/docs/stake/cli-commands.md b/docs/stake/cli-commands.md index 5ee307baa7..77c7c19f2d 100644 --- a/docs/stake/cli-commands.md +++ b/docs/stake/cli-commands.md @@ -40,7 +40,7 @@ Some address parameters we need to highlight here: | ValidatorAddr | validator operator’s address, used in governance ops like voting. | | SideConsAddr | block producer’s address on side chain, i.e. consensus address. BC has another parameter named `PubKey`, here SideConsAddr replaced that for BSC. Only BSC validators need this parameter. | | SideVoteAddr | A bls public key. It's used by validators to vote for blocks, so the BSC chain can finalize blocks within two block periods in normal. ｜ -| SideFeeAddr | fees are collected in this address on BSC, Only BSC validators need this parameter. Due to different token units, there are some BNB left as dust when sending block rewards from BNB Smart Chain to Beacon Chain. Those BNB will be sent to fee address.| +| SideFeeAddr | fees are collected in this address on BSC, Only BSC validators need this parameter. Due to different token units, there are some BNB left as dust when sending block rewards from BNB Smart Chain to BNB Beacon Chain. Those BNB will be sent to fee address.| ### Examples Showing Usage of `bsc-create-validator` @@ -287,7 +287,7 @@ bnbcli staking side-unbonding-delegation [delegator-addr] [operator-addr] [flags | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -309,7 +309,7 @@ bnbcli staking side-unbonding-delegations [delegator-addr] [flags] | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -330,7 +330,7 @@ bnbcli staking side-val-unbonding-delegation [operator-addr] [flags] | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -350,7 +350,7 @@ bnbcli staking side-redelegation [delegator-addr] [src-operator-addr] [dst-opera | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -371,7 +371,7 @@ bnbcli staking side-redelegations [delegator-addr] [flags] | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -390,7 +390,7 @@ bnbcli staking side-val-redelegations [operator-addr] [flags] ``` | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | ### Example @@ -406,7 +406,7 @@ bnbcli staking side-val-redelegations bva12hlquylu78cjylk5zshxpdj6hf3t0tahqmr98n | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | --------------------------------------------------- | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | bsc/chapel | chain-id of the side chain the validator belongs to | Yes | @@ -423,7 +423,7 @@ bnbcli staking side-pool --side-chain-id=bsc --chain-id=Binance-Chain-Tigris | **parameter name** | **Example** | **Explanation** | **required** | | ------------------- | ----------------- | ------------------------------------------------------------ | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | | --top | 10 | number of validators to be returned. set as maximum number of validators by default | Option | @@ -439,7 +439,7 @@ bnbcli staking side-top-validators --top 10 --side-chain-id=bsc --chain-id=Binan | **Parameter Name**| **Example** | **Explanation** | **Required** | | ------------------- | ----------------- | ------------------------------------------------------------ | ------------ | -| --chan-id | Binance-Chain-XXX | the chain id of Beacon Chain | Yes | +| --chan-id | Binance-Chain-XXX | the chain id of BNB Beacon Chain | Yes | | --side-chain-id | chapel | chain-id of the side chain the validator belongs to | Yes | | --jail-involved | true | if true, meaning that the jailed validators will be involved to count | Option | diff --git a/docs/token-bind-tool.md b/docs/token-bind-tool.md index fd43ac4c8c..fea935f082 100644 --- a/docs/token-bind-tool.md +++ b/docs/token-bind-tool.md @@ -41,7 +41,7 @@ make build --to 0xde9Aa1d632b48d881B50528FC524C88474Ec8809 --amount 100000000:BNB ``` - 2.2 You can also transfer BNB from other BNB Smart Chain account with [Metamask](https://docs.binance.org/smart-chain/wallet/metamask.html). + 2.2 You can also transfer BNB from other BNB Smart Chain account with [Metamask](https://docs.bnbchain.org/smart-chain/wallet/metamask.html). ## Bind BEP2 token with BEP20 token @@ -49,9 +49,9 @@ make build Suppose you have already issued a BEP2 token, and you want to deploy a BEP20 token and bind it with existing BEP2 token: -1. Import bep2 token owner key(Send bind transaction on Beacon Chain): +1. Import bep2 token owner key(Send bind transaction on BNB Beacon Chain): - 1.1 From ledger: connect ledger to your computer and open Beacon Chain App + 1.1 From ledger: connect ledger to your computer and open BNB Beacon Chain App ```shell script bnbcli keys add bep2TokenIssuer --ledger --index {your ledger key index} ``` diff --git a/docs/tokens-cross-chain.md b/docs/tokens-cross-chain.md index 84a86b18cb..d77c1d213e 100644 --- a/docs/tokens-cross-chain.md +++ b/docs/tokens-cross-chain.md @@ -5,9 +5,9 @@ sidebar_position: 2 # Cross-chain Token Management -The dual-chain architecture of Beacon Chain & BNB Smart Chain empowers you to build your own decentralized apps. The native cross-chain communication mechanism allows tokens to be transferred between BC and BSC easily. +The dual-chain architecture of BNB Beacon Chain & BNB Smart Chain empowers you to build your own decentralized apps. The native cross-chain communication mechanism allows tokens to be transferred between BC and BSC easily. -BNB Smart Chain and Beacon Chain work together to ensure that one token can circulate in both formats with confirmed total supply and be used in different use cases. +BNB Smart Chain and BNB Beacon Chain work together to ensure that one token can circulate in both formats with confirmed total supply and be used in different use cases. ## BEP2/BEP8 Token Owner diff --git a/docs/tokens.md b/docs/tokens.md index 46e32df389..af11193ac8 100644 --- a/docs/tokens.md +++ b/docs/tokens.md @@ -1,7 +1,7 @@ # Asset Management ## Introduction -Assets are stored as `tokens` on Beacon Chain, and the below management actions are available. All the assets are complied with [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). +Assets are stored as `tokens` on BNB Beacon Chain, and the below management actions are available. All the assets are complied with [BEP2](https://github.com/bnb-chain/BEPs/blob/master/BEP2.md). The [fees](trading-spec.md#fees) that are due must be paid in BNB before any of these operations can be executed. The fees for testnet and mainnet are different. diff --git a/docs/trading-spec.md b/docs/trading-spec.md index de4a99e299..8bd445ab50 100644 --- a/docs/trading-spec.md +++ b/docs/trading-spec.md @@ -3,7 +3,7 @@ ## Orders Orders are the requests for client to buy or sell tokens into other tokens on Binance DEX. -It is a standard type of Beacon Chain transaction. Orders are composed of the below parameters. +It is a standard type of BNB Beacon Chain transaction. Orders are composed of the below parameters. 1. Symbol Pairs: the list pair the order wants to trade. 2. Order Type: Binance DEX only accept LIMIT orders, which is adhering to SEC definitions of LIMIT orders @@ -59,7 +59,7 @@ For GTE order, if a GTE order can execute against another order as a whole, the Order would expire after 72 hours once it is booked on a block. A whole order book scan would happen every UTC mid-night to filter out all the expired orders. After the scan, all the expired orders would be removed from the order book, the locked quantity in the account would be unlocked. Before this action all the existing orders in the order book is subject to matching. !!! Tip - As discussed in [BEP-67](https://https://github.com/bnb-chain/BEPs/blob/master/BEP67.md), those orders in the best 500 price levels on both ask and bid side will be expired after **30 days** instead of 72 hours. Meanwhile, the expiration fee is unchanged. BEP67 is already implemented and has been activated after Testnet Nightingale Upgrade. Beacon Chain Mainnet will be upgraded to support BEP-67 soon. + As discussed in [BEP-67](https://https://github.com/bnb-chain/BEPs/blob/master/BEP67.md), those orders in the best 500 price levels on both ask and bid side will be expired after **30 days** instead of 72 hours. Meanwhile, the expiration fee is unchanged. BEP67 is already implemented and has been activated after Testnet Nightingale Upgrade. BNB Beacon Chain Mainnet will be upgraded to support BEP-67 soon. ## Precision diff --git a/docs/validator/overview.md b/docs/validator/overview.md index e33f578ee6..546df3d06d 100644 --- a/docs/validator/overview.md +++ b/docs/validator/overview.md @@ -5,17 +5,17 @@ hide_table_of_contents: false --- # Overview -BNB Smart Chain is an innovative solution to bring programmability and interoperability to Beacon Chain. BNB Smart Chain relies on a system of 50 validators with [Proof of Staked Authority (PoSA) consensus](https://github.com/bnb-chain/whitepaper/blob/master/WHITEPAPER.md#consensus-and-validator-quorum) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. +BNB Smart Chain is an innovative solution to bring programmability and interoperability to BNB Beacon Chain. BNB Smart Chain relies on a system of 50 validators with [Proof of Staked Authority (PoSA) consensus](https://github.com/bnb-chain/whitepaper/blob/master/WHITEPAPER.md#consensus-and-validator-quorum) that can support short block time and lower fees. The most bonded validator candidates of staking will become validators and produce blocks. The double-sign detection and other slashing logic guarantee security, stability, and chain finality. Other than the 29 active validators, BSC will introduce more validators, e.g. another 20 inactive validators, into the validator set as backups, which will be called “Candidates”. Candidates will produce blocks and charge gas fees in BSC mainnet, but in a much less chance than the official validator set of 29 elected. The unavailable candidates will be slashed as well though in a smaller size. A decent motivation is expected to be maintained so that the candidate validators are willing to ensure the quality and help secure BSC. -In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to Beacon Chain about the stale blocking, resume it and eventually propose a re-election of active validator set. +In an extreme case, if a majority of the active 29 validators get attacked and offline, Candidate Validators can report to BNB Beacon Chain about the stale blocking, resume it and eventually propose a re-election of active validator set. ## What is Validator? -BNB Smart Chain relies on a set of validators who are responsible for committing new blocks in the blockchain. These validators participate in the consensus protocol by signing blocks that contain cryptographic signatures signed by each validator's private key. The validator set is determined by a staking module built on Beacon Chain for BNB Smart Chain, and propagated every day UTC 00:00 from BC to BSC via Cross-Chain communication. +BNB Smart Chain relies on a set of validators who are responsible for committing new blocks in the blockchain. These validators participate in the consensus protocol by signing blocks that contain cryptographic signatures signed by each validator's private key. The validator set is determined by a staking module built on BNB Beacon Chain for BNB Smart Chain, and propagated every day UTC 00:00 from BC to BSC via Cross-Chain communication. ## Economics diff --git a/docs/wallet/binance.md b/docs/wallet/binance.md index fd77f20fa3..1bcf52331d 100644 --- a/docs/wallet/binance.md +++ b/docs/wallet/binance.md @@ -6,7 +6,7 @@ hide_table_of_contents: false # Binance Extension Wallet ## What is it? -Binance Extension Wallet is a crypto Wallet for Beacon Chain and BNB Smart Chain. You can send and receive funds on Beacon Chain, BNB Smart Chain and cross-chain transfers between both of BNB Chain’s blockchains. +Binance Extension Wallet is a crypto Wallet for BNB Beacon Chain and BNB Smart Chain. You can send and receive funds on BNB Beacon Chain, BNB Smart Chain and cross-chain transfers between both of BNB Chain’s blockchains. In the future, Binance Extension Wallet will add support for Ethereum blockchain and enable access for distributed applications, or "Dapps" in your browser! diff --git a/docs/wallet/extension/ledger.md b/docs/wallet/extension/ledger.md index 0c379305af..a81789a5f2 100644 --- a/docs/wallet/extension/ledger.md +++ b/docs/wallet/extension/ledger.md @@ -13,7 +13,7 @@ Binance Extension Wallet v1.121.1 is released and verified on **Firefox and Chro Next: 1. Your first step is to plug your[ Ledger](https://shop.ledger.com/pages/back-to-school?r=da6d9b98e517) into your computer. Ensure it powers on and then input the pin you chose when setting up your ledger. -2. Select and open the Ethereum Application. If you haven't installed Ethereum Application, please read this [guide](https://docs.binance.org/smart-chain/wallet/ledger.html#app-installation-instructions) +2. Select and open the Ethereum Application. If you haven't installed Ethereum Application, please read this [guide](https://docs.bnbchain.org/smart-chain/wallet/ledger.html#app-installation-instructions) 3. Enabling contract data for BEP20. The first item in the settings menu is “Contract Data”. Push down both buttons to select it. Once you have set your ledger up like this the first time, you won’t have to do it again each time you want to use it with Binance Extension wallet. 4. Open BNB Chain Extension Wallet and select "BNB Smart Chain" network 5. Choose "Hardware Wallet" in Settings. Then, click on "Connect" diff --git a/docs/wallet/faq.md b/docs/wallet/faq.md index 981e41f190..b5636d821f 100644 --- a/docs/wallet/faq.md +++ b/docs/wallet/faq.md @@ -3,9 +3,9 @@ ## Tokens not visible after withdrawing from Binance Many users who interact with a centralized exchange like Binance eventually want to withdraw to a wallet that they fully control, like MetaMask. So once you've used their withdraw form, what could be scarier than not seeing your tokens? -First, you'll need to use the MetaMask add Custom Network feature to add the Beacon Chain or BNB Smart Chain's RPC URLs endpoints to your MetaMask. +First, you'll need to use the MetaMask add Custom Network feature to add the BNB Beacon Chain or BNB Smart Chain's RPC URLs endpoints to your MetaMask. -Once you've added the Beacon Chain or the BNB Smart Chain to your MetaMask, you will be able to select different networks to view the assets (you may need to add Custom Tokens too) held by your selected account on that network. +Once you've added the BNB Beacon Chain or the BNB Smart Chain to your MetaMask, you will be able to select different networks to view the assets (you may need to add Custom Tokens too) held by your selected account on that network. ## How Much BNB You Need To Send Tokens diff --git a/docs/wallet/infinitywallet.md b/docs/wallet/infinitywallet.md index dadcae07f3..c43ea3392f 100644 --- a/docs/wallet/infinitywallet.md +++ b/docs/wallet/infinitywallet.md @@ -136,7 +136,7 @@ The **Infinity Wallet** is currently available to be downloaded for desktop devi ## Connect to DeFi Platforms and Dapps -Infinity Wallet supports the ability for users to connect securely to decentralized application on the BNB Smart Chain, Beacon Chain and Ethereum. +Infinity Wallet supports the ability for users to connect securely to decentralized application on the BNB Smart Chain, BNB Beacon Chain and Ethereum. To connect your wallet make sure the platform you are connecting to supports Wallet Connect, then go to your Infinity Wallet and click **WalletConnect** in the bottom left corner. diff --git a/docs/wallet/math.md b/docs/wallet/math.md index 6b970317dd..5b43327605 100644 --- a/docs/wallet/math.md +++ b/docs/wallet/math.md @@ -50,7 +50,7 @@ Go to explorer to verify BNB is sent: ## Transfer BNB from BSC to BC in Testnet 1. Create your Binance Chain Ganges Testnet address with tbnbcli -* Download the binary [here](https://github.com/binance-chain/node/releases/tag/v0.8.1) +* Download the binary [here](https://github.com/bnb-chain/node/releases/tag/v0.8.1) > If you already have a backup of your recovery phrase from Binance Chain Ganges Testnet, it can be reused here. ``` tbnbcli keys add {wallet-alias} diff --git a/docs/wallet/wallet_api.md b/docs/wallet/wallet_api.md index cb31c8da3a..938081ab7a 100644 --- a/docs/wallet/wallet_api.md +++ b/docs/wallet/wallet_api.md @@ -10,15 +10,15 @@ Binance Extension Wallet injects a global API into websites visited by its users This API specification borrows heavily from API MetaMask provided, considering the massive adoption. So Web3 site developers can easily connect their dApps with the Binance Extension Wallet. The APIs allow websites to request users' BNB Smart Chain addresses, read data from the blockchain the user is connected to, and prompt the users to sign messages and transactions. -The presence of the provider object `window.BinanceChain` indicates a Beacon Chain/BNB Smart Chain user. +The presence of the provider object `window.BinanceChain` indicates a BNB Beacon Chain/BNB Smart Chain user. The API this extension wallet provides includes API specified by [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) and API defined by [MetaMask](https://docs.metamask.io/guide/ethereum-provider.html) (including some massively relied on legacy ones). ## Development Progress -Currently (version 1.112.8) as Binance Extension Wallet natively supports Beacon Chain, we are planning to open a series of APIs for dApp developers to interact with Beacon Chain. At the end of the day, most [APIs available in Beacon Chain javascript sdk](https://github.com/binance-chain/javascript-sdk/tree/master/docs) would be available. +Currently (version 1.112.8) as Binance Extension Wallet natively supports BNB Beacon Chain, we are planning to open a series of APIs for dApp developers to interact with BNB Beacon Chain. At the end of the day, most [APIs available in BNB Beacon Chain javascript sdk](https://github.com/bnb-chain/javascript-sdk/tree/master/docs) would be available. Currently, only the following is supported: -* [`transfer`](https://github.com/binance-chain/javascript-sdk/tree/master/docs#transfer-tokens) +* [`transfer`](https://github.com/bnb-chain/javascript-sdk/tree/master/docs#transfer-tokens) ## Difference with MetaMask @@ -93,7 +93,7 @@ function App( ) { const { account, connect, reset, status } = useWallet() return (
-

Beacon Chain Connector

+

BNB Beacon Chain Connector

{status === 'disconnected' ? ( ) : ( @@ -144,12 +144,12 @@ These are the IDs of the BNB Smart Chains that Binance Extension Wallet supports | 0x38 | 56 | BNB Smart Chain Main Network (bsc-mainnet) | | 0x61 | 97 | BNB Smart Chain Test Network (bsc-testnet) | -This API can also return chain ids of Beacon Chains if users switch to them. The possible return value would be: +This API can also return chain ids of BNB Beacon Chains if users switch to them. The possible return value would be: | Chain Id | Network | | -------------------- | ---------------------------------------- | -| Binance-Chain-Tigris | Beacon Chain Main Network (bbc-mainnet) | -| Binance-Chain-Ganges | Beacon Chain Test Network (bbc-testnet) | +| Binance-Chain-Tigris | BNB Beacon Chain Main Network (bbc-mainnet) | +| Binance-Chain-Ganges | BNB Beacon Chain Test Network (bbc-testnet) | ## Properties @@ -243,15 +243,15 @@ BinanceChain ### BinanceChain.bnbSign(address: string, message: string): Promise<{publicKey: string, signature: string}> -*We prepared an example for this API, please check out: https://github.com/binance-chain/js-eth-personal-sign-examples for more detail* +*We prepared an example for this API, please check out: https://github.com/bnb-chain/js-eth-personal-sign-examples for more detail* -Like `eth_sign` enable dApp to verify a user has control over an ethereum address by signing an arbitrary message. We provide this method for dApp developers to request the signature of arbitrary messages for Beacon Chain (BC) and BNB Smart Chain (BSC). +Like `eth_sign` enable dApp to verify a user has control over an ethereum address by signing an arbitrary message. We provide this method for dApp developers to request the signature of arbitrary messages for BNB Beacon Chain (BC) and BNB Smart Chain (BSC). -If `address` parameter is a Beacon Chain address (start with `bnb` or `tbnb`), we will simply **calculate sha256 hash of the message** and let the user sign the hash with their BNB Beacon Chain address' private key. Note: Beacon Chain uses the same elliptic curve (`secp256k1`) as Ethereum. +If `address` parameter is a BNB Beacon Chain address (start with `bnb` or `tbnb`), we will simply **calculate sha256 hash of the message** and let the user sign the hash with their BNB Beacon Chain address' private key. Note: BNB Beacon Chain uses the same elliptic curve (`secp256k1`) as Ethereum. If `address` parameter is a BNB Smart Chain address (start with `0x`), the message would be hashed in the same way as with [`eth_sign`](https://eth.wiki/json-rpc/API#eth_sign). -The returned `publicKey` would be a compressed encoded format (a hex string encoded 33 bytes starting with "0x02", "0x03") for Beacon Chain. And uncompressed encoded format (a hex string encoded 65 bytes starting with "0x04"). +The returned `publicKey` would be a compressed encoded format (a hex string encoded 33 bytes starting with "0x02", "0x03") for BNB Beacon Chain. And uncompressed encoded format (a hex string encoded 65 bytes starting with "0x04"). The returned `signature` would be bytes encoded in hex string starting with `0x`. For BinanceChain, its r,s catenated 64 bytes in total. For BNB Smart Chain, like `eth_sign`, its r, s catenated 64 bytes and a recover byte in the end. @@ -261,17 +261,17 @@ The returned `signature` would be bytes encoded in hex string starting with `0x` ### BinanceChain.switchNetwork(networkId: string): Promise<{networkId: string}> -As Binance Extension Wallet natively supports Beacon Chain and BNB Smart Chain which are heterogeneous blockchains run in parallel. APIs would be different in any situation. (We would open APIs for Beacon Chain very soon). +As Binance Extension Wallet natively supports BNB Beacon Chain and BNB Smart Chain which are heterogeneous blockchains run in parallel. APIs would be different in any situation. (We would open APIs for BNB Beacon Chain very soon). Developers could judge which network is selected by user currently via `BinanceChain.chainId` or listening to the `chainChanged` event via `BinanceChain.on('chainChanged', callback)`. -To request for network switching, developers could invoke this API with `bbc-mainnet` (Beacon Chain Main Network), `bsc-mainnet` (BNB Smart Chain Main Network), `bbc-testnet` (Beacon Chain Test Network), `bsc-testnet` (BNB Smart Chain Test Network) to prompt user to agree on network switching. +To request for network switching, developers could invoke this API with `bbc-mainnet` (BNB Beacon Chain Main Network), `bsc-mainnet` (BNB Smart Chain Main Network), `bbc-testnet` (BNB Beacon Chain Test Network), `bsc-testnet` (BNB Smart Chain Test Network) to prompt user to agree on network switching. ### BinanceChain.requestAccounts() Request all accounts maintained by this extension. -The `id` in response would be used as `accountId` for the APIs for Beacon Chain. +The `id` in response would be used as `accountId` for the APIs for BNB Beacon Chain. This method would return an array of Account: ``` @@ -310,7 +310,7 @@ For example: ### BinanceChain.transfer({fromAddress:string, toAddress:string, asset:string, amount:number, memo?: string, sequence?: number, accountId:string, networkId:string})> -Transfer certain `amount` of `asset` (BNB or BEP2) on Beacon Chain. +Transfer certain `amount` of `asset` (BNB or BEP2) on BNB Beacon Chain. `accountId` could be retrieved from the `BinanceChain.requestAccounts` API (`id` field of each account) diff --git a/docs/wallet_api.md b/docs/wallet_api.md index 6b74dc1e39..77d83576a9 100644 --- a/docs/wallet_api.md +++ b/docs/wallet_api.md @@ -10,12 +10,12 @@ BInance Extension Wallet injects a global API into websites visited by its users This API specification borrows heavily from API MetaMask provided, considering the massive adoption. So Web3 site developers can easily connect their dApps with the Binance Extension Wallet. The APIs allow websites to request users' BNB Smart Chain addresses, read data from the blockchain the user is connected to, and prompt the users to sign messages and transactions. -The presence of the provider object `window.BinanceChain` indicates a Beacon Chain/BNB Smart Chain user. +The presence of the provider object `window.BinanceChain` indicates a BNB Beacon Chain/BNB Smart Chain user. The API this extension wallet provides includes API specified by [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) and API defined by [MetaMask](https://docs.metamask.io/guide/ethereum-provider.html) (including some massively relied on legacy ones). ## Development Progress -Currently (version 1.112.8) as Binance Extension Wallet natively supports Beacon Chain, we are planning to open a series of APIs for dApp developers to interact with Beacon Chain. At the end of the day, most [APIs available in Beacon Chain javascript sdk](https://github.com/bnb-chain/javascript-sdk/tree/master/docs) would be available. +Currently (version 1.112.8) as Binance Extension Wallet natively supports BNB Beacon Chain, we are planning to open a series of APIs for dApp developers to interact with BNB Beacon Chain. At the end of the day, most [APIs available in BNB Beacon Chain javascript sdk](https://github.com/bnb-chain/javascript-sdk/tree/master/docs) would be available. Currently, only the following is supported: * [`transfer`](https://github.com/bnb-chain/javascript-sdk/tree/master/docs#transfer-tokens) @@ -93,7 +93,7 @@ function App( ) { const { account, connect, reset, status } = useWallet() return (
-

Beacon Chain Connector

+

BNB Beacon Chain Connector

{status === 'disconnected' ? ( ) : ( @@ -144,12 +144,12 @@ These are the IDs of the BNB Smart Chains that Binance Extension Wallet supports | 0x38 | 56 | BNB Smart Chain Main Network (bsc-mainnet) | | 0x61 | 97 | BNB Smart Chain Test Network (bsc-testnet) | -This API can also return chain ids of Beacon Chains if users switch to them. The possible return value would be: +This API can also return chain ids of BNB Beacon Chains if users switch to them. The possible return value would be: | Chain Id | Network | | -------------------- | ---------------------------------------- | -| Binance-Chain-Tigris | Beacon Chain Main Network (bbc-mainnet) | -| Binance-Chain-Ganges | Beacon Chain Test Network (bbc-testnet) | +| Binance-Chain-Tigris | BNB Beacon Chain Main Network (bbc-mainnet) | +| Binance-Chain-Ganges | BNB Beacon Chain Test Network (bbc-testnet) | ## Properties @@ -245,13 +245,13 @@ BinanceChain *We prepared an example for this API, please check out: https://github.com/bnb-chain/js-eth-personal-sign-examples for more detail* -Like `eth_sign` enable dApp to verify a user has control over an ethereum address by signing an arbitrary message. We provide this method for dApp developers to request the signature of arbitrary messages for Beacon Chain (BC) and BNB Smart Chain (BSC). +Like `eth_sign` enable dApp to verify a user has control over an ethereum address by signing an arbitrary message. We provide this method for dApp developers to request the signature of arbitrary messages for BNB Beacon Chain (BC) and BNB Smart Chain (BSC). -If `address` parameter is a Beacon Chain address (start with `bnb` or `tbnb`), we will simply **calculate sha256 hash of the message** and let the user sign the hash with their BNB Beacon Chain address' private key. Note: Beacon Chain uses the same elliptic curve (`secp256k1`) as Ethereum. +If `address` parameter is a BNB Beacon Chain address (start with `bnb` or `tbnb`), we will simply **calculate sha256 hash of the message** and let the user sign the hash with their BNB Beacon Chain address' private key. Note: BNB Beacon Chain uses the same elliptic curve (`secp256k1`) as Ethereum. If `address` parameter is a BNB Smart Chain address (start with `0x`), the message would be hashed in the same way as with [`eth_sign`](https://eth.wiki/json-rpc/API#eth_sign). -The returned `publicKey` would be a compressed encoded format (a hex string encoded 33 bytes starting with "0x02", "0x03") for Beacon Chain. And uncompressed encoded format (a hex string encoded 65 bytes starting with "0x04"). +The returned `publicKey` would be a compressed encoded format (a hex string encoded 33 bytes starting with "0x02", "0x03") for BNB Beacon Chain. And uncompressed encoded format (a hex string encoded 65 bytes starting with "0x04"). The returned `signature` would be bytes encoded in hex string starting with `0x`. For BinanceChain, its r,s catenated 64 bytes in total. For BNB Smart Chain, like `eth_sign`, its r, s catenated 64 bytes and a recover byte in the end. @@ -261,17 +261,17 @@ The returned `signature` would be bytes encoded in hex string starting with `0x` ### BinanceChain.switchNetwork(networkId: string): Promise<{networkId: string}> -As Binance Extension Wallet natively supports Beacon Chain and BNB Smart Chain which are heterogeneous blockchains run in parallel. APIs would be different in any situation. (We would open APIs for Beacon Chain very soon). +As Binance Extension Wallet natively supports BNB Beacon Chain and BNB Smart Chain which are heterogeneous blockchains run in parallel. APIs would be different in any situation. (We would open APIs for BNB Beacon Chain very soon). Developers could judge which network is selected by users currently via `BinanceChain.chainId` or listening to the `chainChanged` event via `BinanceChain.on('chainChanged', callback)`. -To request for network switching, developers could invoke this API with `bbc-mainnet` (Beacon Chain Main Network), `bsc-mainnet` (BNB Smart Chain Main Network), `bbc-testnet` (Beacon Chain Test Network), `bsc-testnet` (BNB Smart Chain Test Network) to prompt user to agree on network switching. +To request for network switching, developers could invoke this API with `bbc-mainnet` (BNB Beacon Chain Main Network), `bsc-mainnet` (BNB Smart Chain Main Network), `bbc-testnet` (BNB Beacon Chain Test Network), `bsc-testnet` (BNB Smart Chain Test Network) to prompt user to agree on network switching. ### BinanceChain.requestAccounts() Request all accounts maintained by this extension. -The `id` in response would be used as `accountId` for the APIs for Beacon Chain. +The `id` in response would be used as `accountId` for the APIs for BNB Beacon Chain. This method would return an array of Account: ``` @@ -310,7 +310,7 @@ For example: ### BinanceChain.transfer({fromAddress:string, toAddress:string, asset:string, amount:number, memo?: string, sequence?: number, accountId:string, networkId:string})> -Transfer certain `amount` of `asset` (BNB or BEP2) on Beacon Chain. +Transfer certain `amount` of `asset` (BNB or BEP2) on BNB Beacon Chain. `accountId` could be retrieved from the `BinanceChain.requestAccounts` API (`id` field of each account) diff --git a/docs/wallets/tutorial/bep8.md b/docs/wallets/tutorial/bep8.md index c925f4850a..a92bba6b4e 100644 --- a/docs/wallets/tutorial/bep8.md +++ b/docs/wallets/tutorial/bep8.md @@ -1,7 +1,7 @@ In this article, we are going to take a tour about how to manage your BEP8 tokens in BNB Chain Testnet [web wallet](https://testnet.binance.org/en/tokens). ## What is BEP8 Token -Since the [Nightingale upgrade](https://community.binance.org/topic/2828) of Binance Chain testnet, a new token protocol [BEP8](https://github.com/binance-chain/BEPs/blob/master/BEP8.md) is introduced. BEP8 protocol targets a different marketplace and provides several potential business cases in areas like micro-financing. +Since the [Nightingale upgrade](https://community.binance.org/topic/2828) of Binance Chain testnet, a new token protocol [BEP8](https://github.com/bnb-chain/BEPs/blob/master/BEP8.md) is introduced. BEP8 protocol targets a different marketplace and provides several potential business cases in areas like micro-financing. Currently, the cost to get a BEP2 token listed on Binance DEX is quite expensive, as it takes more system resources, which is more suitable for the mature and large scale projects with enough recognition in the markets. At the same time, more micro-financing cases like copyright owners, peer production, and community incentive points are looking for flexible tokenization and trading platforms to support their current works and share their potential future success. New BEP8 tokens market is introduced to meet these demands and will increase the liquidity of utility tokens, which is similar to Small and Medium Enterprise (SME) board in the traditional stock markets diff --git a/docs/wallets/tutorial/ledger-nano-s-usage-guide.md b/docs/wallets/tutorial/ledger-nano-s-usage-guide.md index 93f30560d6..29bdef499f 100644 --- a/docs/wallets/tutorial/ledger-nano-s-usage-guide.md +++ b/docs/wallets/tutorial/ledger-nano-s-usage-guide.md @@ -61,7 +61,7 @@ You will then be redirected to the Trading Interface. For your security, please read the information displayed in the following popup and confirm that the address shown on your Ledger device matches the one shown on-screen.
Press the right button on your device to confirm that the address matches (You must do this to continue). -## How to send Beacon Chain crypto assets +## How to send BNB Beacon Chain crypto assets Confirming a trade on a Ledger Wallet: diff --git a/docs/wallets/tutorial/trezor-model-t-user-guide.md b/docs/wallets/tutorial/trezor-model-t-user-guide.md index 2de7820cd9..85f5555dbf 100644 --- a/docs/wallets/tutorial/trezor-model-t-user-guide.md +++ b/docs/wallets/tutorial/trezor-model-t-user-guide.md @@ -64,7 +64,7 @@ Please make sure that you have seed phrase backed up. ![img](https://lh6.googleusercontent.com/h7xez7MrpBQt8n888v8mmWujn4rNKH88h11zesBkBe-pvCKtqiPM_IE3MZRRGuQi47DOLRAgrVMY3g8a-QXvhkpnJOLacHgyTeUe5FvKT2LAVTX7t8NMfaHdzoP53dbbG4pz4j_2) -## How to send Beacon Chain crypto assets +## How to send BNB Beacon Chain crypto assets 1) Click on the “Balances” navigation button in the Trading Interface to view your account balances. @@ -85,7 +85,7 @@ Please make sure that you have seed phrase backed up. ![img](https://lh4.googleusercontent.com/CgV9tpPpgGZFowBeka3VUqgA5zCfT7gLxi3m1qujN00lFKGJu8uSoTpP8_VnF5qCasdPHb-S2FQEEKHGm37xjXJhCmxyxvpWN_mQ6CHb6Q4aCaHb4Y4MmOeZrUibQeGLPtyqFON2) -## How to trade Beacon Chain crypto assets +## How to trade BNB Beacon Chain crypto assets 1) You can place your order on trading page diff --git a/docs/wallets/wallets.md b/docs/wallets/wallets.md index 530e20fffa..7c4368ce37 100644 --- a/docs/wallets/wallets.md +++ b/docs/wallets/wallets.md @@ -1,6 +1,6 @@ # Wallet Support -* List of Wallets Supporting Beacon Chain Mainnet +* List of Wallets Supporting BNB Beacon Chain Mainnet | Number | Wallet Name | Website |DEX Feature Available|Testnet Support|WalletConnect Support| | ------ | ------------------------------------------------------ | -------------------------------- |-----| -----|-----| diff --git a/static/api-swagger/index.html b/static/api-swagger/index.html index 512f41e93c..5ecb9ba292 100644 --- a/static/api-swagger/index.html +++ b/static/api-swagger/index.html @@ -1711,7 +1711,7 @@

HTTP API

API and SDK Documentation

Version: 1.0.0
-
The Binance Chain HTTP API provides access to a Beacon Chain node deployment and related data services.
+
The Binance Chain HTTP API provides access to a BNB Beacon Chain node deployment and related data services.
diff --git a/swagger.json b/swagger.json index bbbb38eb81..e76c99f9bb 100644 --- a/swagger.json +++ b/swagger.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "HTTP API", - "description": "The Binance Chain HTTP API provides access to a Beacon Chain node deployment and related data services.", + "description": "The Binance Chain HTTP API provides access to a BNB Beacon Chain node deployment and related data services.", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html"