Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add token recovery guide #434

Merged
merged 3 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/assets/bcfusion/token-recovery-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/bcfusion/token-recovery-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/bc-fusion/post-fusion/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before the final sunset hardfork:

After the final sunset hadfork (i.e., post fusion):

* Users should wait for the release of token recovery dApp, and use the token recovery dApp to get the assets back on
* Users should wait for the release of [the token recovery dApp](token-recovery.md), and use the token recovery dApp to get the assets back on
the BSC network.

Important: to use the token recovery dApp, the private key/mnemonic for your BC account will be used to prove that you
Expand Down
91 changes: 91 additions & 0 deletions docs/bc-fusion/post-fusion/token-recovery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Token Recovery dApp

To facilitate the token migration after the Beacon Chain shutdown,
the [BEP299](https://github.com/bnb-chain/BEPs/blob/master/BEPs/BEP-299.md) is proposed
to recover the BEP2/BEP8 assets on the Beacon Chain to the BSC chain. This document will guide you through the process
of token recovery.

Be noted:

* Token recovery dApp will only be available post fusion (the Beacon Chain has been shutdown).
* Only [the crosschain bound/mirrored assets](../users/assets.md) can be recovered.

URL:

- **Testnet**: To be updated.

- **Mainnet**: To be updated.

## Steps

### Step 1: Connect to your BC wallet.

![](../../assets/bcfusion/token-recovery-1.png){:style="width:800px"}

When opening the token recovery dApp, you will be prompted to connect to your wallet.

![](../../assets/bcfusion/token-recovery-2.png){:style="width:800px"}

[BNB Chain Wallet](https://chromewebstore.google.com/detail/bnb-chain-wallet/fhbohimaelbohpjbbldcngcnapndodjp)
and [Trust Wallet](https://trustwallet.com/) will be supported (Trust wallet support will come soon).

### Step 2: Select the BEP2/BEP8 assets to be recovered.

![](../../assets/bcfusion/token-recovery-3.png){:style="width:800px"}

Click the "Recover Now" button to start the recovery process.

### Step 3: Input the receiver address.

![](../../assets/bcfusion/token-recovery-4.png){:style="width:800px"}

The receiver address on BSC is the address where the BEP2/BEP8 assets will be recovered to.
The token recovery dApp will try to get the BSC address from your wallet automatically.

![](../../assets/bcfusion/token-recovery-5.png){:style="width:800px"}

If the address is not populated or you want to use a different address, you can also input the address you want to use.

Be noted:

* The address will receive the BEP2/BEP8 assets on BSC. Please input it correctly to avoid any fund loss.

* The account will be used in the later steps for sending a transaction to BSC. So it should have some BNB on BSC for
the gas fee.

### Step 4: Confirm the receiver address and signing.

![](../../assets/bcfusion/token-recovery-6.png){:style="width:800px"}

By confirming the token recovery request, you will be promoted to sign a message via your wallet.

### Step 5: Send the token recovery transaction to BSC.

![](../../assets/bcfusion/token-recovery-7.png){:style="width:800px"}

![](../../assets/bcfusion/token-recovery-8.png){:style="width:800px"}

You will be asked to switch to the BSC network in your wallet.

![](../../assets/bcfusion/token-recovery-mismatch-address.png){:style="width:800px"}

The connected address should be the receiver address inputted in the previous step. If it is not, the token recovery
dApp will detect it and ask you to switch to the correct account in your wallet.

![](../../assets/bcfusion/token-recovery-9.png){:style="width:800px"}

Then click the "Confirm" button to send the token recovery transaction to BSC.

![](../../assets/bcfusion/token-recovery-10.png){:style="width:800px"}

You will be prompted to sign and confirm the transaction, which will be sent to the BSC.

### Step 6: Wait for the recovery.

![](../../assets/bcfusion/token-recovery-11.png){:style="width:800px"}

After the transaction is sent, the token recovery dApp will populate a window to indicate that
the token recovery request is sent successfully.

Finally, you need to wait for 7 days for the BEP2/BEP8 assets to be recovered on BSC and received in your wallet.

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ nav:
- Overview: ./bc-fusion/overview.md
- Post Fustion:
- Merkle Proof Verification: ./bc-fusion/post-fusion/merkle-tree-verify.md
- Token Recovery: ./bc-fusion/post-fusion/token-recovery.md
- FAQ: ./bc-fusion/post-fusion/faq.md
- For Users:
- Manage Your Assets: ./bc-fusion/users/assets.md
Expand Down
Loading