Skip to content

Commit

Permalink
Merge pull request #425 from bob-collective/derrek/docs-update-gatewa…
Browse files Browse the repository at this point in the history
…y-roadmap

docs: update intro, add gateway explainer, misc updates
  • Loading branch information
nud3l authored Dec 14, 2024
2 parents 083b5e9 + 748ae61 commit 5d7ed47
Show file tree
Hide file tree
Showing 20 changed files with 5,755 additions and 44 deletions.
13 changes: 7 additions & 6 deletions docs/docs/learn/builder-guides/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
sidebar_position: 2
---

# BOB Gateway
# Integrate BOB Gateway in Your App

## Overview

[BOB Gateway](https://docs.gobob.xyz/learn/guides/bitcoin-bridge/) is a Bitcoin intent bridge that unlocks Bitcoin liquidity by reducing the number of steps to onboard users, saving time and money. Users can go from **BTC** on Bitcoin to **staked BTC LSTs** with a single Bitcoin transaction.
[BOB Gateway](https://docs.gobob.xyz/learn/guides/bitcoin-bridge/) is a Bitcoin intent bridge that unlocks Bitcoin liquidity by reducing the number of steps to onboard users to your app, saving time and money. For example, users can go from **BTC** on Bitcoin to **staked BTC LSTs** with a single Bitcoin transaction.

Our SDK makes it possible for you to bring this UX directly into your app.

Expand All @@ -18,7 +16,10 @@ Our SDK makes it possible for you to bring this UX directly into your app.

1. Gateway finalizes the transaction. After trustlessly verifying the user's Bitcoin transaction with an on-chain [Light Client](/learn/builder-guides/relay.md), Gateway sends the LP's wrapped Bitcoin to the user's EVM address. If the user requested a Bitcoin LST/LRT, that token is minted using the LP's wrapped Bitcoin before it is sent to the user.

This SDK makes it possible to do steps 2, 3, and 4 in your application's front end.
This SDK exposes helper functions for steps 2, 3, and 4 to be used in your application's front end.
:::info Learn More
Discover the architecture of BOB Gateway and how it simplifies Bitcoin transactions by visiting our [BOB Gateway introduction page](../introduction/gateway).
:::

## Step-by-Step Integration Guide

Expand Down Expand Up @@ -80,7 +81,7 @@ The SDK will handle automatically when the `toToken` has a fungible ERC20 token,
```ts
const strategies = await gatewaySDK.getStrategies();
const strategy = strategies.find(
(contract) => contract.integration.name === "pell-wbtc",
(contract) => contract.integration.name === "pell-wbtc"
)!;
const quoteParamsStaking: GatewayQuoteParams = {
...quoteParams,
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5d7ed47

Please sign in to comment.