Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
120 commits
Select commit Hold shift + click to select a range
c09de5c
Update docusaurus.config.js
RumeelHussainbnb Mar 14, 2022
f717151
Update README.md
RumeelHussainbnb Mar 14, 2022
1760b91
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
7703ac6
Update binance.md
RumeelHussainbnb Mar 14, 2022
7b81bec
Update cross-chain-transfer.md
RumeelHussainbnb Mar 14, 2022
4f88b93
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
133b6ee
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
21e1753
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
059c29f
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
8a7d462
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
0694d95
Update docusaurus.config.js
RumeelHussainbnb Mar 14, 2022
527e891
Update docusaurus.config.js
RumeelHussainbnb Mar 14, 2022
21d516b
Update wallet_api.md
RumeelHussainbnb Mar 14, 2022
1b0c7f7
bnb-update-2.5
RumeelHussainbnb Mar 14, 2022
1ee3bcc
Update README.md
RumeelHussainbnb Mar 14, 2022
171aa1c
Update docusaurus.config.js
RumeelHussainbnb Mar 14, 2022
29879de
bnb-update-2.5
RumeelHussainbnb Mar 14, 2022
00af33e
Merge branch 'master' of https://github.com/bnb-chain/docs-site-v2
RumeelHussainbnb Mar 14, 2022
d8d5e3b
Create CNAME
unclezoro Mar 15, 2022
91b30f9
Update index.js
RumeelHussainbnb Mar 15, 2022
d97e84c
Update docusaurus.config.js
RumeelHussainbnb Mar 15, 2022
441a780
update-env-variables
RumeelHussainbnb Mar 15, 2022
1a67faa
bn-update
RumeelHussainbnb Mar 15, 2022
73afb23
bnb-update
RumeelHussainbnb Mar 15, 2022
313e1d3
bnb-update
RumeelHussainbnb Mar 15, 2022
cff74bd
bnb-update
RumeelHussainbnb Mar 15, 2022
3697857
bnb-update
RumeelHussainbnb Mar 15, 2022
af70eb5
bnb-update
RumeelHussainbnb Mar 15, 2022
848ee78
bnb-update
RumeelHussainbnb Mar 15, 2022
5d6ed06
Create CNAME
RumeelHussainbnb Mar 15, 2022
bcc7140
bnb-update
RumeelHussainbnb Mar 15, 2022
e47e0b0
Merge branch 'master' of https://github.com/bnb-chain/bnb-chain.githu…
RumeelHussainbnb Mar 15, 2022
2c0ef25
Update rpc.md
RumeelHussainbnb Mar 15, 2022
4e6de13
bnb-update-2.5
RumeelHussainbnb Mar 15, 2022
67dd74b
Merge branch 'master' of https://github.com/bnb-chain/bnb-chain.githu…
RumeelHussainbnb Mar 15, 2022
dd8de3f
bnb-update-2.5
RumeelHussainbnb Mar 15, 2022
4687fa4
bnb-update-2.5
RumeelHussainbnb Mar 15, 2022
71ff35a
bnb-update-2.5
RumeelHussainbnb Mar 15, 2022
797fe71
bnb-upate-2.5
RumeelHussainbnb Mar 15, 2022
b2c704e
Update docusaurus.config.js
RumeelHussainbnb Mar 15, 2022
a3e3905
Merge pull request #1 from bnb-chain/RumeelHussainbnb-patch-1
RumeelHussainbnb Mar 15, 2022
734b7e0
bnb-update
RumeelHussainbnb Mar 15, 2022
1d2831d
Merge branch 'master' of https://github.com/bnb-chain/bnb-chain.githu…
RumeelHussainbnb Mar 15, 2022
cfa53e1
Create deploy.yml
RumeelHussainbnb Mar 21, 2022
8f66277
Create test-deploy.yml
RumeelHussainbnb Mar 21, 2022
1fd8860
Update bnbIntro.md
RumeelHussainbnb Mar 21, 2022
81c515b
Update deploy.yml
RumeelHussainbnb Mar 21, 2022
0e6a42a
Update test-deploy.yml
RumeelHussainbnb Mar 21, 2022
51bbd54
Update deploy.yml
RumeelHussainbnb Mar 21, 2022
9e62f80
Update bnbIntro.md
RumeelHussainbnb Mar 21, 2022
815c1a7
Update getting-started.md
RumeelHussainbnb Mar 21, 2022
335309d
Delete azure-static-web-apps-black-tree-0e961eb10.yml
RumeelHussainbnb Mar 21, 2022
405cd70
Delete azure-static-web-apps-lemon-ground-008bf5910.yml
RumeelHussainbnb Mar 21, 2022
74b4402
Delete azure-static-web-apps-zealous-bay-0a3f1bd10.yml
RumeelHussainbnb Mar 21, 2022
3120827
Update BSCmainnet.md
RumeelHussainbnb Mar 21, 2022
5ec1f8e
Update BSCtestnet.md
RumeelHussainbnb Mar 21, 2022
561352a
Update BSCmainnet.md
RumeelHussainbnb Mar 21, 2022
64fbcb3
Update getting-started.md
RumeelHussainbnb Mar 21, 2022
2c838c9
Update README.md
RumeelHussainbnb Mar 21, 2022
5a1f662
Update BSCmainnet.md
RumeelHussainbnb Mar 22, 2022
d5b0d57
Update BSCmainnet.md
RumeelHussainbnb Mar 22, 2022
990d71b
Update BSCmainnet.md
RumeelHussainbnb Mar 22, 2022
c4dbb73
Update rpc.md
RumeelHussainbnb Mar 28, 2022
b262993
updated for search bar
RumeelHussainbnb Apr 11, 2022
366e159
updated to include algolia search
RumeelHussainbnb Apr 11, 2022
340f598
Update docusaurus.config.js
RumeelHussainbnb Apr 11, 2022
d2d0c02
Update docusaurus.config.js
RumeelHussainbnb Apr 11, 2022
0bcc06a
About BSC Application Side Chain (BAS)
RumeelHussainbnb Apr 12, 2022
b9603c8
Update sidebars.js
RumeelHussainbnb Apr 12, 2022
25d0c45
Update sidebars.js
RumeelHussainbnb Apr 12, 2022
32c1fbf
Update sidebars.js
RumeelHussainbnb Apr 13, 2022
58f55e7
Update sidebars.js
RumeelHussainbnb Apr 13, 2022
5d9863c
Update issue-BEP20.md
RumeelHussainbnb Apr 20, 2022
e03dbce
Update general.md
RumeelHussainbnb Apr 21, 2022
3757e27
Update BSC-FAQs-general.md
RumeelHussainbnb Apr 21, 2022
3cf6071
added BNBChain List
RumeelHussainbnb Apr 21, 2022
1b2d4e8
Update docusaurus.config.js
RumeelHussainbnb Apr 21, 2022
10ce395
updated edit page option
RumeelHussainbnb Apr 21, 2022
9cda2f6
updated edit page option
RumeelHussainbnb Apr 21, 2022
520c99f
Update BSC-FAQs-validator.md
RumeelHussainbnb May 8, 2022
8058465
Update bas.md
RumeelHussainbnb May 19, 2022
ac39aad
updated BAS abbreviation
RumeelHussainbnb May 19, 2022
671277e
Update community.md
RumeelHussainbnb May 19, 2022
23f9336
Update sharding-and-multichain.md
RumeelHussainbnb May 19, 2022
f4a9c51
Update scaling.md
RumeelHussainbnb May 19, 2022
08c8dec
updated the hardware requirement
RumeelHussainbnb May 19, 2022
3ef5b64
Update README.md
RumeelHussainbnb May 19, 2022
875b5a9
Added Gnosis Tutorial Navigation
RumeelHussainbnb May 24, 2022
54993cc
Update gnosis.md
RumeelHussainbnb May 24, 2022
a66bc2b
CName Updated from world to org
RumeelHussainbnb Jun 1, 2022
3c7f6dc
Update CNAME
RumeelHussainbnb Jun 1, 2022
d0ab927
Update CNAME
RumeelHussainbnb Jun 1, 2022
0e179e8
Update CNAME
RumeelHussainbnb Jun 1, 2022
e5a7758
Update CNAME
RumeelHussainbnb Jun 1, 2022
7553218
Update ecosystem.md
RumeelHussainbnb Jun 6, 2022
83dee3c
updated blog link
RumeelHussainbnb Jun 6, 2022
0e47e20
cname updated
RumeelHussainbnb Jun 6, 2022
cc1332e
updated links to old documentation
RumeelHussainbnb Jun 7, 2022
4038bbf
Merge branch 'master' of https://github.com/bnb-chain/bnb-chain.githu…
RumeelHussainbnb Jun 7, 2022
4278ccf
updated ecosystem image
RumeelHussainbnb Jun 7, 2022
a686d22
Social media links updated
RumeelHussainbnb Jun 7, 2022
6519796
Update general.md
RumeelHussainbnb Jun 7, 2022
9e646d5
Added Docs for BAS
RumeelHussainbnb Jun 8, 2022
58e047e
Merge branch 'master' of https://github.com/bnb-chain/bnb-chain.githu…
RumeelHussainbnb Jun 8, 2022
990a173
Added Docs for BAS
RumeelHussainbnb Jun 8, 2022
282cbf9
Added docs for BAS
RumeelHussainbnb Jun 8, 2022
e3657e6
Added link to tutorial how to build on BNB Chain
RumeelHussainbnb Jun 8, 2022
97c562e
Updated BAS Docs
RumeelHussainbnb Jun 9, 2022
e00047b
Updated Docusaurus.config file
RumeelHussainbnb Jun 9, 2022
3facc6d
Updated Docusaurus.config file
RumeelHussainbnb Jun 9, 2022
54b8da3
Updated Docusaurus.config Edit Page
RumeelHussainbnb Jun 9, 2022
d8785a5
Updated FAQs
RumeelHussainbnb Jun 9, 2022
47e1a56
Updated BNB sidechain content
RumeelHussainbnb Jun 13, 2022
1e85189
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
eb6a562
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
e652def
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
eb26d08
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
2726570
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
e4ddc3b
Updated content for BNB Sidechain
RumeelHussainbnb Jun 14, 2022
4536897
Updated Sidebar and tutorials
RumeelHussainbnb Jun 14, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 0 additions & 45 deletions .github/workflows/azure-static-web-apps-black-tree-0e961eb10.yml

This file was deleted.

45 changes: 0 additions & 45 deletions .github/workflows/azure-static-web-apps-lemon-ground-008bf5910.yml

This file was deleted.

45 changes: 0 additions & 45 deletions .github/workflows/azure-static-web-apps-zealous-bay-0a3f1bd10.yml

This file was deleted.

42 changes: 42 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- master
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
#custom domain name
cname: docs.bnbchain.org
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
24 changes: 24 additions & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Test deployment

on:
pull_request:
branches:
- master
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.bnbchain.org
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Proposal for Revision of Binance Smart Chain Documentation
# BNB Chain Documentation

## Overview
This is a proposal for the revision of the Binance Smart Chain documentation for a better user experience and navigation. This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. Navigation bar are updated providing a better division of topics and easier navigation for the users. Multiple files have been re-formatted and new files are also included.
This is the updated documentation for BNB Chain for a better user experience and navigation. This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. Navigation bar are updated providing a better division of topics and easier navigation for the users. Multiple files have been re-formatted and new files are also included.

### Prerequisites
- **Node** _version >= 14 or above_
Expand Down Expand Up @@ -29,6 +29,22 @@ Clone the reository and run the following commands.

### Local Development

Install the packages.

Using `npm`

```
npm install
```

Using Yarn

```
$ yarn install
```

Start local development server

Using `npm`

```
Expand All @@ -44,6 +60,7 @@ $ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build
We recommend to use the yarn package for building and deploying this website.

Using `npm`

Expand Down
23 changes: 11 additions & 12 deletions docs/BC-FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ sidebar_position: 2
hide_table_of_contents: true
---

# Beacon Chain FAQ
# Beacon Chain FAQs

### What is Beacon Chain , or Binance DEX?
### What is 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.
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.

### What is the design principle of Beacon Chain ?

Expand All @@ -19,7 +18,7 @@ The main focuses for the design of Beacon Chain are:
- High performance: low latency, high throughput for a large user base, and high liquidity trading.
We target to achieve 1 second block times, with 1 confirmation finality.
- Low cost: in both fees and liquidity cost.
- Easy user experience: as friendly as Binance.com.
- Easy user experience <!-- : as friendly as Binance.com. -->
- Fair trading: minimize front-running, to the extent possible.
- Evolvable: able to develop with forever-improving technology stack, architecture, and ideas.

Expand Down Expand Up @@ -53,7 +52,7 @@ Beacon Chain native coins will be sent to their new wallets.
### How can I register on 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/binance-chain/docs-site/blob/master/docs/wallets.md) that supports Beacon Chain . Then you can trade BNB or other assets stored on that address.
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.

### How can I send orders on Binance DEX?
#### Order
Expand Down Expand Up @@ -338,13 +337,13 @@ Feel free to talk to Binance community.

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://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:
* [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.
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.

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.

Expand All @@ -366,9 +365,9 @@ Validators then vote to accept the proposal.
A deposit is taken to prevent network abuse.
Once the proposal is accepted, the owner of the base asset can list the trading pair.

For more information about this process please check the [listing guide](https://github.com/binance-chain/docs-site/blob/master/docs/list.md).
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 Beacon Chain and Binance DEX?

A wallet provider may choose to only support the feature set of Beacon Chain , which would just
cover wallets, addresses, balances and transfers.<br/>
Expand Down
10 changes: 5 additions & 5 deletions docs/BEP20.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Then users can use [Remix IDE](https://remix.ethereum.org) and [Metamask](wallet

## Interact with Contract with [Web3](https://www.npmjs.com/package/web3) and NodeJS.

### Connect to BNB Smart Chain 's public RPC endpoint
### Connect to BNB Smart Chain's public RPC endpoint

```js
const Web3 = require('web3');
Expand All @@ -32,7 +32,7 @@ const web3 = new Web3('https://bsc-dataseed1.binance.org:443');
const web3 = new Web3('https://data-seed-prebsc-1-s1.binance.org:8545');
```

### Create a wallet
### Create a Wallet

```javascript
web3.eth.accounts.create([entropy]);
Expand All @@ -51,7 +51,7 @@ web3.eth.accounts.create();

```

### Recover a wallet
### Recover a Wallet

```javascript

Expand All @@ -60,7 +60,7 @@ const account = web3.eth.accounts.privateKeyToAccount("0xe500f5754d761d74c3eb6c2
```


### Check balance
### Check Balance

```javascript
web3.eth.getBalance(holder).then(console.log);
Expand All @@ -75,7 +75,7 @@ The balance will be bumped by e18 for BNB.
6249621999900000000
```

### Create transaction
### Create Transaction

**Parameters**

Expand Down
Loading