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

Add BOB Gateway guide and simplify onboarding page #264

Merged
merged 8 commits into from
Jun 18, 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
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.
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.
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.
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.
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.
72 changes: 72 additions & 0 deletions docs/docs/learn/guides/bitcoin-bridge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
sidebar_position: 3
sidebar_label: Bridge from Bitcoin to BOB
---

# BOB Gateway

## Bridge from Bitcoin to BOB

[BOB Gateway](https://app.gobob.xyz) allows you to swap your Bitcoin into wrapped Bitcoin with a single, unified interface so you can put your bitcoin to work earning yield faster than ever before.

It's built on a trustless, RFQ-based cross-chain [swap protocol](../../../build/examples/btc-swap/) that connects professional LPs with users through a seamless swapping experience. Essentially, LPs handle the complexities of bridging on behalf of users in exchange for a fee.

:::tip Interested in providing liquidity?
If you are interested in being an LP for the BOB Gateway bridge, please send us an email at `gateway [ at ] gobob.xyz`.
:::

All you need is a Bitcoin wallet with some BTC to send and an EVM-compatible wallet to receive your wrapped Bitcoin on BOB. We'll even send you some ETH to cover the fees of your first few transactions on BOB.

## Video Tutorial

<iframe width="560" height="315" src="https://www.youtube.com/embed/xExdId-s4xA?playlist=xExdId-s4xA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

## Step-by-step Guide

1. Open the [BOB Gateway website](https://bob-fusion-git-feat-external-bridges-interlay.vercel.app/bridge?type=deposit).

2. Select the Bitcoin network by clicking "Ethereum" and then selecting "Bitcoin" from the list.

![Switch to Bitcoin](./bitcoin-bridge-01.png)

3. Click `Connect Wallet` in the top-right corner.

![Click Connect Wallet](./bitcoin-bridge-02.png)

3. Click `Connect your EVM Wallet (Mandatory)`.

![Click Connect your EVM Wallet](./bitcoin-bridge-03.png)

4. Choose your EVM wallet provider. In this example we’ll use MetaMask.

![Select EVM Wallet](./bitcoin-bridge-04.png)

:::tip Choosing your EVM address
You will receive your wrapped Bitcoin at the EVM address you connect at this step.
:::

5. Click `Wallet` in the top-right corner again to connect your Bitcoin wallet.

![Click Connect Wallet](./bitcoin-bridge-05.png)

6. Click `Connect your Bitcoin Wallet (Optional)`.

![Click Connect your Bitcoin Wallet](./bitcoin-bridge-06.png)

7. Select your Bitcoin wallet provider. In this example we'll use Leather.

![Select Bitcoin Wallet](./bitcoin-bridge-07.png)

8. Type the amount of BTC that you would like to bridge from Bitcoin to BOB.

![Amount field with 0.00001 BTC typed in](./bitcoin-bridge-08.png)

9. Click “Bridge Asset,” then Confirm the transaction in your wallet.

![Wallet confirmation pop-up](./bitcoin-bridge-09.png)

10. That’s it! After a few Bitcoin blocks your BTC will be finalized on BOB. You can verify the bridging is complete with the Activity section on the right of the page or by opening your EVM wallet and seeing that your balance of wrapped BTC on BOB has increased.

![Bridge in process](./bitcoin-bridge-10.png)

If you have any questions, please reach out to us on [Discord](https://discord.gg/gobob) or [Telegram](https://t.me/+CyIcLW2nfaFlNDc1). Welcome to the Bitcoin Renaissance on BOB!
12 changes: 7 additions & 5 deletions docs/docs/learn/guides/ethereum-bridge.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
sidebar_position: 3
sidebar_position: 4
sidebar_label: Bridge from Ethereum to BOB
---

# Bridge from Ethereum to BOB

The [BOB Bridge](https://app.gobob.xyz) allows you to move ETH between Ethereum and BOB.
The [BOB Bridge](https://app.gobob.xyz/bridge) allows you to move ETH between Ethereum and BOB.

## Step-by-step Guide

1. Open the [BOB Bridge website](https://bob-fusion-git-feat-external-bridges-interlay.vercel.app/bridge?type=deposit)
1. Open the [BOB Bridge website](https://app.gobob.xyz/bridge).

2. Click `Connect Wallet` in the top-right corner
2. Click `Connect Wallet` in the top-right corner.

![Click Connect Wallet](./ethereum-bridge/eth-bridge-01.png)

3. Click `Connect your EVM Wallet (Mandatory)`
3. Click `Connect your EVM Wallet (Mandatory)`.

![Click Connect your EVM Wallet](./ethereum-bridge/eth-bridge-02.png)

Expand Down Expand Up @@ -50,3 +50,5 @@ You may choose to use a “3rd Party” bridge. Each of these buttons will direc
10. That’s it! After ~3 minutes your tokens will be bridged to BOB. You can verify the bridging is complete with the Activity section on the right or by clicking “Withdraw” and seeing that your token balance on BOB has increased.

![Bridge in process](./ethereum-bridge/eth-bridge-09.png)

If you have any questions, please reach out to us on [Discord](https://discord.gg/gobob) or [Telegram](https://t.me/+CyIcLW2nfaFlNDc1). Welcome to BOB!
4 changes: 2 additions & 2 deletions docs/docs/learn/guides/faq/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
position: 5
position: 6
label: "FAQs"
---

Expand Down Expand Up @@ -54,6 +54,6 @@ We recommend using the following network settings:
- **New RPC URL**: https://bob-mainnet.public.blastapi.io
- **Chain ID**: 60808
- **Symbol**: ETH
- **Block Explorer URL**: https://explorer.gobob.xyz
- **Block Explorer URL**: https://explorer.gobob.xyz

![Networks](./metamask-network.png)
20 changes: 10 additions & 10 deletions docs/docs/learn/guides/onboard-to-bob.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ sidebar_label: Onboarding to BOB

# Onboarding to BOB

## Supported Bridges

There are several ways to bridge tokens to and from BOB, depending on which network and token you're interested in moving. Here is an overview of your options.

| Bridge Name | Supported Networks | Supported Tokens |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| [BOB Bridge](https://app.gobob.xyz/bridge)<br/> ([OP Standard Bridge docs](https://docs.optimism.io/builders/app-developers/bridging/standard-bridge)) | Ethereum | WBTC, tBTC, rETH, wstETH, STONE, USDT, USDC, DAI, eDLLR, ETH, eSOV, ALEX |
| [Relay](https://relay.link/bridge/) | 10 EVM Chains (including Optimism, Arbitrum, Linea, zkSync Era, Rari...) | ETH |
| [Meson](https://meson.fi/) | BTC L2s (including Merlin, BEVM, Bitlayer, Core, ZetaChain...)<br/><br/>Non-EVM (Solana, Tron, Aptos, Sui)<br/><br/>EVM chains (including Arbitrum, Base, Immutable X, Scroll, zkLink, Mode, Manta...) | wBTC, ETH, USDT |
| [Orbiter Finance](https://www.orbiter.finance/) | BTC L2s (including Merlin, BEVM, Bitlayer, ZetaChain...) <br/><br/> Non-EVM (Solana, Starknet) <br/><br/> EVM chains (including Arbitrum, Polygon, Base, Immutable X, Scroll, opBNB, Mode, Mantle, Manta...) | wBTC, ETH |
| LayerZero | L1s (Including BNB, Avalanche, Fantom, BNB)<br/><br/>EVM Chains (including Polygon, Optimism, Arbitrum, zkEVM, Astar…) | ETH, USDC, Omnichain Fungible Tokens (OFTs) |
| [Owlto Finance](https://owlto.finance/bridge) | BTC L2s (including Merlin, BSquare, BEVM, Bitlayer, Taproot...)<br/><br/>Non-EVM (Solana, Starknet)<br/><br/>EVM chains (40+) | BTC, ETH, USDC, USDT |
| Where Your Tokens Are | How to Move Your Tokens to BOB |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Centralized Exchanges (e.g. Coinbase, Binance, OKX) | Bridge to Base, then [bridge from Base to BOB](https://app.gobob.xyz/bridge) |
| Bitcoin | [Use the BOB Gateway](https://app.gobob.xyz/bridge) |
| Bitcoin Layer 2s | [Use one of our trusted bridges](https://app.gobob.xyz/bridge) |
| Ethereum | [Use one of our trusted bridges](https://app.gobob.xyz/bridge) |
| Ethereum Layer 2s | [Use one of our trusted bridges](https://app.gobob.xyz/bridge) |
| Other EVM-compatible Networks | [Use one of our trusted bridges](https://app.gobob.xyz/bridge) |
| Solana | [Meson](https://meson.fi/), [Orbiter Finance](https://www.orbiter.finance/), or [Owlto Finance](https://owlto.finance/bridge) |
| Non-EVM-compatible Networks (Tron, Starknet, Aptos, Sui) | [Meson](https://meson.fi/) |
2 changes: 1 addition & 1 deletion docs/docs/learn/guides/use-bob.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
sidebar_label: "Testing BOB"
---

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/learn/introduction/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ If you are keen to build on BOB or contribute to BOB itself:

## More

- Liquidity providers: If you are interested in being an LP for the BOB Gateway bridge, please send us an email at `gateway [ at ] gobob.xyz`.
- Press kit: [BOB Press Kit](https://build-on-bitcoin.notion.site/BOB-Press-Kit-1be66c38713d480eab01000bdd164206)
- Brand assets: [BOB Brand Assets](https://drive.google.com/drive/u/0/folders/1c30QDkyWgaV8xSEpCXFWJj1WQyUjSm7N)
- Brand assets: [BOB Brand Assets](https://drive.google.com/drive/u/0/folders/1c30QDkyWgaV8xSEpCXFWJj1WQyUjSm7N)
Loading