Merge branch 'development' into doc-stakingv4

# Conflicts:
#	website/sidebars.json

Author: mariusmihaic

.github/workflows/deploy-production.yml

@@ -2,7 +2,7 @@ name: deploy-production
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   repository_dispatch:
     types: deploy-production
   workflow_dispatch:
@@ -13,35 +13,33 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          ref: master
+          ref: main
+          fetch-depth: 0
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: "12.x"
+          node-version: "16.x"
       - name: Install packages
-        working-directory: website
-        run: |
-          npm install
+        run: npm install
       - name: Build website
-        working-directory: website
-        run: |
-          npm run build
+        run: npm run build
         env:
           CI: false
           REACT_APP_ALGOLIA_SEARCH_KEY: ${{ secrets.ALGOLIA_SEARCH_KEY }}
+          REACT_APP_ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: "us-east-1"
       - name: Deploy to S3 bucket
-        run: aws s3 sync ./website/build/docs/ s3://${{ secrets.AWS_S3_BUCKET_PRODUCTION }} --delete
+        run: aws s3 sync ./build/ s3://${{ secrets.AWS_S3_BUCKET_PRODUCTION }} --delete
       - name: Slack Notification
         uses: rtCamp/action-slack-notify@master
         env:
           SLACK_ICON_EMOJI: ":page_with_curl:"
-          SLACK_USERNAME: docs.elrond.com
+          SLACK_USERNAME: docs.multiversx.com
           SLACK_MESSAGE: ${{ secrets.AWS_S3_BUCKET_PRODUCTION }}
           SLACK_FOOTER: ""
           MSG_MINIMAL: true

.github/workflows/deploy-staging.yml

@@ -14,34 +14,32 @@ jobs:
       - uses: actions/checkout@v2
         with:
           ref: development
+          fetch-depth: 0
       - name: Use Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: "12.x"
+          node-version: "16.x"
       - name: Install packages
-        working-directory: website
-        run: |
-          npm install
+        run: npm install
       - name: Build website
-        working-directory: website
-        run: |
-          npm run build
+        run: npm run build
         env:
           CI: false
           REACT_APP_ALGOLIA_SEARCH_KEY: ${{ secrets.ALGOLIA_SEARCH_KEY }}
+          REACT_APP_ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: "us-east-1"
       - name: Deploy to S3 bucket
-        run: aws s3 sync ./website/build/docs/ s3://${{ secrets.AWS_S3_BUCKET_STAGING }} --delete
+        run: aws s3 sync ./build/ s3://${{ secrets.AWS_S3_BUCKET_STAGING }} --delete
       - name: Slack Notification
         uses: rtCamp/action-slack-notify@master
         env:
           SLACK_ICON_EMOJI: ":page_with_curl:"
-          SLACK_USERNAME: docs.elrond.com
+          SLACK_USERNAME: staging-docs.multiversx.com
           SLACK_MESSAGE: ${{ secrets.AWS_S3_BUCKET_STAGING }}
           SLACK_FOOTER: ""
           MSG_MINIMAL: true

.github/workflows/rust-tutorial-ci.yml

@@ -17,4 +17,4 @@ jobs:
           default: true
           toolchain: nightly
       - name: Run rust tests
-        run: ./rust-tutorial-ci.sh
+        run: ./scripts/rust-tutorial-ci.sh

.gitignore

@@ -1,6 +1,24 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
 .DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
 
-node_modules
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
 lib/core/metadata.js
 lib/core/MetadataBlog.js
@@ -14,7 +32,6 @@ website/i18n/*
 desktop.ini
 
 /sam/build.yaml
-/build
 /.vscode
 
 tags
@@ -23,3 +40,5 @@ tags
 /target
 /testing/extract-tutorial-code/target
 Cargo.lock
+
+.idea

README.md

@@ -1,6 +1,6 @@
-# Elrond docs
+# MultiversX docs
 
-The repository containing the [documentation](https://docs.elrond.com) for the Elrond Network protocol.
+The repository contains the [documentation](https://docs.multiversx.com) for the MultiversX Network protocol.
 
 ## About
 
@@ -9,19 +9,17 @@ This repository also has GitHub actions that will trigger the real-time updating
 
 ## How to use locally
 
-In order to ensure that the new added content is correctly aligned and every Markdown feature is working as intended, one can run the project on a local machine.
+In order to ensure that the newly added content is correctly aligned and every Markdown feature is working as intended, one can run the project on a local machine.
 
 ### Requirements:
 
 - a `git` client installed
-- `nodejs` and `npm` installed
+- `nodejs` (v16.14.2) and `npm` installed
 - optional, but useful: an IDE (Visual Code for example)
 
 ### Steps:
 
-
 - clone the repository
-- go to the `website` directory from a terminal
 - run `npm install` (only for the first usage)
 - run `npm start`
 - access `http://localhost:3000` to view your local version of the docs
@@ -37,6 +35,7 @@ Once a proposal to update the documentation is submitted, it will be subject to
 ### Audience
 
 Anyone can contribute to the docs. Any help is appreciated. Here are some ways in which you can contribute:
+
 - update parts of the documentation that no longer match the actual behaviour.
 - document features that aren't documented yet.
 - add additional information about a component.
@@ -45,20 +44,24 @@ Anyone can contribute to the docs. Any help is appreciated. Here are some ways i
 
 ### Guidelines
 
-- external contributions will be made to the `external` branch.
+Each documentation page should include a `Edit this page` link that will redirect the user to the corresponding GitHub edit page. 
+
+Alternatively, contributions can be made manually by following the steps below:
+
+- external contributions will be made to the `development` branch.
 - you can contribute from GitHub directly (not recommended) or by working locally and pushing the changes (recommended).
 - the documentation pages are to be found inside the `docs` directory at the corresponding category.
 - please follow `docs/utils.md` for Markdown examples.
 
-A web version of the Markdown examples is available [here](https://docs.elrond.com/utils/).
+A web version of the Markdown examples is available [here](https://docs.multiversx.com/utils/).
 
 ### Opening a `pull request`
 
-- create a new branch starting from `external`.
+- create a new branch starting from `development`.
 - push the changes to the new branch.
-- open a `pull request` from your branch to `external` branch.
-- wait for Elrond members to review your pull request.
+- open a `pull request` from your branch to `development` branch.
+- wait for MultiversX members to review your pull request.
 
-Once approved, the pull request will be merged into the `external` branch. From time to time (and depending on the emergency of the changes) we will merge the `external` branch into `development` or `master` branches.
+Once approved, the pull request will be merged into the `development` branch. From time to time (and depending on the emergency of the changes) we will merge the `development` branch into `master` branch.
 
 ## **Thank you!**

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/bridge/architecture.md

@@ -0,0 +1,31 @@
+---
+id: architecture
+title: Architecture
+---
+
+[comment]: # (mx-abstract)
+
+Ad-Astra Bridge is a system that allows for the transfer of ERC20 tokens between the Ethereum and MultiversX networks. The system is composed of several contracts and relayers that work together to facilitate the transfer of tokens.
+
+[comment]: # (mx-context-auto)
+
+## Ethereum Contracts
+- **Repo**: https://github.com/multiversx/mx-bridge-eth-sc-sol
+- **Safe (1)**: A contract that allows users to deposit ERC20 tokens that they want to transfer to the MultiversX network.
+- **Bridge(2)**: A contract that facilitates the transfer of tokens from Ethereum to MultiversX.
+
+[comment]: # (mx-context-auto)
+
+## MultiversX Contracts
+- **Repo**: https://github.com/multiversx/mx-bridge-eth-sc-rs
+- **Safe (3)**: A contract that allows users to deposit ESDT tokens that they want to transfer to the Ethereum network.
+- **Bridge (4)**: A contract that facilitates the transfer of tokens from MultiversX to Ethereum.
+- **MultiTransfer (5)**: A helper contract that is used to perform multiple token transfers at once.
+- **BridgedTokensWrapper (6)**: A helper contract that is used to support wrapping the same token from multiple chains into a single ESDT token.
+
+[comment]: # (mx-context-auto)
+
+## Relayers
+- **Repo**: https://github.com/multiversx/mx-bridge-eth-go
+- **5 Relayers**: Managed by the MultiversX Foundation.
+- **5 Relayers**: Distributed to the MultiversX validators community, with each validator having one relayer.

docs/bridge/multiple-chains.md

@@ -0,0 +1,17 @@
+---
+id: multiple-chains
+title: Multiple chains
+---
+
+[comment]: # (mx-abstract)
+
+An ESDT token can be bridged between multiple chains by using the `BridgedTokensWrapper` contract.
+
+[comment]: # (mx-context-auto)
+
+## Support for Multiple Chains for the same token
+The **BridgedTokensWrapper (6)** contract facilitates the use case of having the same token on multiple chains. It accepts the chain-specific ESDT token and mints a universal ESDT token that can be used on any application within the MultiversX network. The universal ESDT token can be converted back to the chain-specific ESDT token using the **BridgedTokensWrapper (6)** contract. This process burns the given universal tokens and sends the chain-specific ESDT tokens to the user.
+
+Internally, the Ad-Astra Bridge system uses the **BridgedTokensWrapper (6)** contract to wrap the chain-specific tokens minted by the **MultiTransfer (5)** contract from multiple chains into a single ESDT token and sends it to the user.
+
+When a user wants to transfer the tokens back to the source network, they must send the universal ESDT token to the **BridgedTokensWrapper (6)** contract, and the chain-specific ESDT token will be sent to the user. After this step, the user can send the chain-specific ESDT token to the **Safe (3)** contract, and the transfer will be performed as described in the previous section.

docs/bridge/transfer-flows.md

@@ -0,0 +1,29 @@
+---
+id: transfer-flows
+title: Transfer Flows
+---
+
+[comment]: # (mx-abstract)
+
+The main functionality of the bridge is to transfer tokens from a network to another. For example, a user can transfer tokens from Ethereum to MultiversX or from MultiversX to Ethereum. 
+The following sections describe the transfer flows for both directions.
+
+[comment]: # (mx-context-auto)
+
+## Ethereum to MultiversX
+1. A user deposits the ERC20 tokens that they want to transfer to the MultiversX network on the **Safe(1)** contract.
+2. The **Safe(1)** contract groups multiple deposits into batches.
+3. After a certain period of time, each batch becomes final and is processed by the relayers.
+4. The relayers propose, vote, and perform the transfer using the **Bridge (4)** contract with a consensus of 7/10 votes.
+5. On the MultiversX network, the same amount of ESDT tokens are minted as were deposited on the Ethereum network.
+6. The user receives the equivalent amount of ESDT tokens on their recipient address on the MultiversX network.
+
+[comment]: # (mx-context-auto)
+
+## MultiversX to Ethereum
+1. A user deposits the ESDT tokens that they want to transfer to the Ethereum network on the **Safe(3)** contract.
+2. The **Safe(3)** contract groups multiple deposits into batches.
+3. After a certain period of time, each batch becomes final and is processed by the relayers.
+4. The relayers propose, vote, and perform the transfer using the **Bridge (2)** contract with a consensus of 7/10 votes.
+5. The user receives the equivalent amount of ERC20 tokens on their recipient address on the Ethereum network.
+6. On the MultiversX network, the ESDT tokens that were transferred are burned.

docs/bridge/whitelist-requirements.md

@@ -0,0 +1,19 @@
+---
+id: whitelist-requirements
+title: Whitelist requirements
+---
+
+[comment]: # (mx-abstract)
+
+Before enabling a token to be sent via the Ad-Astra bridge, the token must be whitelisted. 
+The whitelisting process is performed with the help of the MultiversX team.
+
+[comment]: # (mx-context-auto)
+
+## Whitelist requirements
+
+1. The MultiversX team must whitelist the token on both the Safe(1) and Safe(3) contracts. Only whitelisted tokens can be bridged.
+2. The token issuer must issue the token on the MultiversX network and submit a branding request manually or using https://assets.multiversx.com/.
+3. The token issuer must assign the MINT&BURN role to the BridgedTokensWrapper (6) contract as per the instructions provided at https://docs.multiversx.com/tokens/esdt-tokens/#setting-and-unsetting-special-roles
+
+**Note**: As an alternative approach, MultiversX team can issue an ESDT token on the MultiversX chain with the same properties as on Ethereum, and give the needed roles to the Smart Contracts, as indicated above. The MultiversX team can then give the token issuer the ownership of token management for that specific ESDT token.