Skip to content

Commit

Permalink
docs: update brand name and links (#125)
Browse files Browse the repository at this point in the history
  • Loading branch information
weiihann authored Jun 30, 2023
1 parent 9db8ff3 commit d7286de
Show file tree
Hide file tree
Showing 112 changed files with 553 additions and 553 deletions.
82 changes: 41 additions & 41 deletions docs/BC-FAQs.md

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/BSC-FAQs-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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:
Expand Down Expand Up @@ -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?

Expand All @@ -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

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/BSC-FAQs-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand All @@ -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 <https://github.com/bnb-chain/BEPs/blob/master/BEP2.md>
A simple token protocol for easy management of asset on BNB Beacon Chain <https://github.com/bnb-chain/BEPs/blob/master/BEP2.md>

BNB is BEP2

Expand Down Expand Up @@ -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”.

Expand Down
10 changes: 5 additions & 5 deletions docs/BSC-FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down Expand Up @@ -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 ?

Expand All @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/api-reference/cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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: <https://dex.binance.org/api/v1/peers>.

Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/dex-api/paths.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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***
Expand Down
10 changes: 5 additions & 5 deletions docs/api-reference/node-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"'
Expand Down Expand Up @@ -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: <https://data-seed-pre-0-s3.binance.org>
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: <https://data-seed-pre-0-s3.binance.org>
**Example**
Expand Down
14 changes: 7 additions & 7 deletions docs/api-reference/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down
Loading

0 comments on commit d7286de

Please sign in to comment.