Skip to content

Commit

Permalink
Restructure docs (aurora-is-near#100)
Browse files Browse the repository at this point in the history
* Restructure docs

* Fix redirects

* Fix links and move old materials out of 'docs' folder

* Remove EVM redirect for now

* Fix links

* Open bridge section by default

* Merge old materials with the new structure

Some parts of the new structure were commented out (sidebars.js).
They need to be written yet.

* Add Forwarder docs

* Fix linter/build errors

* Change phrasing for CEX transfers

* Add Coinbase article for Forwarder

* Update lockfile

* Add Forwarder video

* Add Forwarder video to Introduction
  • Loading branch information
Karkunow authored Apr 16, 2024
1 parent 8e24d8f commit 57ff7ba
Show file tree
Hide file tree
Showing 104 changed files with 7,146 additions and 4,839 deletions.
3 changes: 3 additions & 0 deletions docs/audits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
sidebar_label: Audit reports
---
95 changes: 0 additions & 95 deletions docs/aurora-cloud/chain.md

This file was deleted.

32 changes: 19 additions & 13 deletions docs/bridge/advanced-features.mdx → docs/bridge/advanced.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,39 @@
---
sidebar_label: Advanced features
title: Advanced Features
sidebar_position: 7
---

Now let’s cover some less popular but also useful bridge features.

### Restore Transfer
## Restore Transfer
This option is useful if you accidentally (or on purpose) hide a transfer and have difficulty finding it later.
It also comes in handy when sometimes the bridge interface would say, “Processing transfer… Should have completed about 2 hours ago.” It does not mean that the transaction hasn’t been completed. More often than not it means that the bridge interface hasn't been updated yet.
It also comes in handy when sometimes the bridge interface would say, “Processing transfer… Should have completed about 2 hours ago.” It does not mean that the transaction hasn’t been completed.
More often than not it means that the bridge interface hasn't been updated yet.

1. To access the option, either click “Restore Transfer” in the upper right corner on the bridge page or enter it manually as rainbowbridge.app/restore.

![rainbow_bridge_46](/img/rainbow_bridge_46.png)

2. Paste the first transaction ID into the field on the page below to get access to the transfer.

The system will automatically locate it, you just need to click “Restore Transfer”. You’ll then get redirected to the bridge page where you can see the transaction and click “Finalize Transfer” in order to get access to your funds, if needed.
The system will automatically locate it, you just need to click “Restore Transfer”.
You’ll then get redirected to the bridge page where you can see the transaction and click “Finalize Transfer” in order to get access to your funds, if needed.

![rainbow_bridge_47](/img/rainbow_bridge_47.png)

### Security
## Security
As its name suggests, this option helps you understand how to secure your assets. This applies to transfers of ERC-20 tokens like USDC **FROM** Ethereum.

![rainbow_bridge_48](/img/rainbow_bridge_48.png)

It explains the difference between limited and unlimited approval in MetaMask. Approval in this case refers to the amount of assets that you are allowed to transfer before the bridge asks you for approval again (in case the amount is set to limited).
It explains the difference between limited and unlimited approval in MetaMask.
Approval in this case refers to the amount of assets that you are allowed to transfer before the bridge asks you for approval again (in case the amount is set to limited).

The page provides a pretty elaborate explanation and examples. If you still have questions, feel free to use the Questions button or our public channels to obtain clarification.

![rainbow_bridge_49](/img/rainbow_bridge_49.png)

### Deploy Token
## Deploy Token
This feature is useful if you want to transfer a token that has not been added to the bridge yet.

![rainbow_bridge_50](/img/rainbow_bridge_50.png)
Expand All @@ -39,20 +42,23 @@ Once you paste the token address, you’ll be redirected to the page with detail

![rainbow_bridge_51](/img/rainbow_bridge_51.png)

### Status communications
## Status communications

https://rainbowbridge.app/status
[https://rainbowbridge.app/status](https://rainbowbridge.app/status)

Sometimes issues come up that interrupt the smooth operation of the bridge, such as DDoS attacks. In order to keep the users up to date, we implemented a status page driven by the CMS, on which we display the full-text of the latest update, and zipped-up (but expandable) summaries of all past updates.
Sometimes issues come up that interrupt the smooth operation of the bridge, such as DDoS attacks. In order to keep the users up to date, we implemented a status page driven by the CMS,
on which we display the full-text of the latest update, and zipped-up (but expandable) summaries of all past updates.

![rainbow_bridge_52](/img/rainbow_bridge_52.png)

Whenever there's a status alert—which can be <span style={{color: 'red', fontWeight: 'bold'}}>red</span> (alert), <span style={{color: '#F9DA78', fontWeight: 'bold'}}>yellow</span> (warning) or <span style={{color: 'green', fontWeight: 'bold'}}>green</span> (all good)—we display a colored banner in the header throughout the entire bridge interface.
Whenever there's a status alert—which can be <span style={{color: 'red', fontWeight: 'bold'}}>red</span> (alert),
<span style={{color: '#F9DA78', fontWeight: 'bold'}}>yellow</span> (warning)
or <span style={{color: 'green', fontWeight: 'bold'}}>green</span> (all good)—we display a colored banner in the header throughout the entire bridge interface.

Green banners are displayed only for 24 hours, and then disappear from the main page (but remain on the historical status page).

That is all, friends! We hope you found this manual useful. Happy bridging!

P.S. If you happen to be interested in what’s going on behind the scenes while you are flowing through a transfer, please read https://aurora.dev/blog/2021-how-the-rainbow-bridge-works.
P.S. If you happen to be interested in what’s going on behind the scenes while you are flowing through a transfer, please read [this](https://aurora.dev/blog/2021-how-the-rainbow-bridge-works).

If you just want more detailed information on bridge features, please reference our user knowledge base at https://help.aurora.dev.
If you just want more detailed information on bridge features, please reference our [user knowledge base](https://help.aurora.dev).
3 changes: 3 additions & 0 deletions docs/bridge/aurora-chains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
sidebar_label: Between Aurora Chains
---
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: Transfers Between Aurora/NEAR
sidebar_position: 3
sidebar_label: Between Aurora and Near
title: Transfers Between Aurora and Near
---

Now let’s get down to the most fascinating part of this manual—transferring assets.
Let’s start with a transfer between Aurora and NEAR networks and move Aurora tokens between them.
In this article we will discuss how transfer between Aurora and Near networks is done by using Rainbow Bridge.

1. Select NEAR as the “From” network, and Aurora as the “To” network.
“Connect” both wallets, and click “Continue”.

:::tip
If you have trouble connecting networks, please refer to the [Bridge Overview](bridge-overview) section.
If you have trouble connecting networks, please refer to the [Bridge Overview](introduction) section.
:::

2. Choose the “Aurora” token to send, and enter the amount you want to transfer. Click “Continue”.
Expand All @@ -21,7 +20,7 @@ We also provide a one-click helper to allow you to send the full token balance i
...and in the case that you’ve chosen ETH, we show you a warning that you may want to keep a bit around for gas fees!

:::tip
If you are wondering why you only see specific tokens, please refer to the [Transfer Overview](transfer-overview) chapter for more information.
If you are wondering why you only see specific tokens, please refer to the [Transfer Overview](introduction) chapter for more information.
:::

![rainbow_bridge_15](/img/rainbow_bridge_15.png)
Expand Down
54 changes: 54 additions & 0 deletions docs/bridge/fast-bridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
sidebar_label: Fast Bridge
title: Fast Bridge
---

Fast Bridge is a solution which enables the transfer of tokens from Near/Aurora to Ethereum with just a few minutes of delay.
As an added advantage, this service also provides the ability to determine the transfer cost right from the start for users.

From the start, the Fast Bridge supports AURORA, WBTC, and USDC transfers, while new tokens will be added in the future.

Compare this this to the classical Rainbow Bridge, which makes it possible to transfer tokens from the Aurora and Near blockchain to Ethereum.
These transactions have longer processing times, typically ranging from 4 to 8 hours, and the final transaction cost remains unpredictable at the time of initiation.

## What’s new for users?

You can now choose to transfer ERC-20 tokens from the Aurora/Near to the Ethereum ecosystem benefitting from the fast transfer function.
With the valid fast transfer, you will be able to bridge your assets, usually in a few minutes.
In the Fast Rainbow Bridge, the cost of the transfer is covered by the relayer, relieving the user from paying the gas fees on the Ethereum side.
The relayer takes care of the gas expenses and ensures that the transaction is executed promptly to mitigate any potential gas price fluctuations.

From the user's point-of-view using Fast Bridge is really simple, just choose it as an option instead doing the Regular Transfer:

![fast-bridge-example](/img/fast-bridge-example.png)

The fee for utilizing the Fast Rainbow Bridge is calculated dynamically and paid in the same tokens that are transferred.
The current fee is equal to ~$20 base fee plus 0.1% of the transferred amount.

## General idea

The Fast Bridge implementation is possible because it doesn't use the Rainbow Bridge's NEAR Light Client on the Ethereum side. Instead, it uses a 3rd party liquidity Provider to facilitate the fast transfer.

Let's imagine that a User wants to transfer some tokens from NEAR to Ethereum in a short time.
If he decided to use the classical Rainbow Bridge because it would take at least 4 hours.

Now let's assume that some Provider already has the target tokens on the Ethereum side and agrees to exchange them for the same tokens on the Near side. In that case:

- The User can lock its tokens with a fee for the Provider on the Near side.
- The Provider can easily check that tokens are locked and transfer tokens to the User on the Ethereum side.
- The Provider will claim his tokens and earned fees on the NEAR side by showing proof of the token transfer from the Ethereum side.

In this scenario, the User should not wait for any NEAR Light Client on Ethereum update and gets tokens on the Ethereum side extremely fast.

The Fast Bridge solution is decentralized and trustless. This is achieved because the Fast Bridge allows multiple relayers to provide liquidity, thus allowing a competitive market for fast transfers.
Users, on the other hand, may claim their tokens back if their transfer was not completed (for example, in case the relayer is down or the provided fee is too low)
within the max transfer time window (currently equals to 4 hours).
Moreover, to claim tokens back on the NEAR side, the relayer must provide proof of the finalized bridge transaction from the Ethereum side.

## Architecture

The following diagram describes the whole flow of the Fast Bridge transfer:

![Fast Bridge Architecture](/img/fast-bridge-arch.avif)

If you want to read more details about it, [here is the article](https://dev.aurora.dev/posts/fast-bridge) on Aurora Developer Portal.
Loading

0 comments on commit 57ff7ba

Please sign in to comment.