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: update intro, add gateway explainer, misc updates #425

Merged
merged 22 commits into from
Dec 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
39dc1c2
Correct "BitVM" to "BitVM2" in Research paper title
derrekcoleman Dec 6, 2024
acddeb7
Change sidebar names for References, Tools
derrekcoleman Dec 6, 2024
5e6ff8c
Create Bug Bounty page
derrekcoleman Dec 6, 2024
e877bcd
Update Roadmap page
derrekcoleman Dec 9, 2024
81269b3
Create Gateway explainer page
derrekcoleman Dec 9, 2024
77e1887
Fix build errors
derrekcoleman Dec 9, 2024
1247e93
Help Vercel find an image for build
derrekcoleman Dec 9, 2024
0ba7deb
Add conceptual intro back to the Gateway builder guide
derrekcoleman Dec 10, 2024
e543254
Update language in Gateway conceptual intro
derrekcoleman Dec 10, 2024
21a512c
Remove redundant step-by-step user stories
derrekcoleman Dec 10, 2024
15a12cb
Add Trust Assumptions section to Gateway
derrekcoleman Dec 11, 2024
c520824
Change "fees" to "gas"
derrekcoleman Dec 11, 2024
ba19348
Remove errant json file
derrekcoleman Dec 11, 2024
56e0d3e
Fix internal linking
derrekcoleman Dec 11, 2024
ce9ef28
Expand on the relationship between OP_RETURN hash and light client
derrekcoleman Dec 11, 2024
fd29942
Expand image width
derrekcoleman Dec 12, 2024
53385be
Update diagram to match dark background
derrekcoleman Dec 12, 2024
b0ad6d0
Correct capitalization
derrekcoleman Dec 13, 2024
b60779b
Add light client economic security
derrekcoleman Dec 13, 2024
0e90a9f
Explain liquidity sniping as a reason proof submission is permissioned
derrekcoleman Dec 13, 2024
7ed3354
Merge branch 'master' into derrek/docs-update-gateway-roadmap
derrekcoleman Dec 13, 2024
748ae61
Rephrase liquidity sniping section
derrekcoleman Dec 13, 2024
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
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.
derrekcoleman marked this conversation as resolved.
Show resolved Hide resolved

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
Loading