You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 13, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
-
# Bridge Adapter Design Document
1
+
# Unified Bridge Adapter
2
2
3
3
## Overview
4
4
5
5
The unified bridge adapter SDK solves the challenge of having an increasing number of chains and growing liquidity fragmentation in two ways. By leveraging existing bridge infrastructure to go cross-chain, and by leveraging existing DEXes to increase the total pool of tokens that can be used with these bridge infrastructure.
6
6
7
-
Document with the info for the bridge could be [found here](./BRIDGE_OVERVIEW.md).
7
+
If you want to integrate another bridge or DEX into the SDK read the following [document](./BRIDGE_OVERVIEW.md).
8
8
9
9
### Unifying Existing Bridges
10
10
11
11
The unified bridge adapter SDK provides a unified framework for interacting with all the various bridges out there. Instead of having to integrate each bridge 1 by 1, a developer simply needs to integrate this sdk to get the benefit of integrating multiple bridges.
While leveraging various existing bridges allows us to move more seamlessly between chains, we also leverage existing DEXes to increase the total pool of tokens that can be taken cross chain.
16
-
Developers simply integrate a single SDK and get the combined benefits of the existing bridges and DEXes that exists today.
16
+
Developers simply integrate a single SDK and get the combined benefits of the existing bridges and DEXes that exist today.
17
17
18
18
## Features
19
19
@@ -45,7 +45,7 @@ The SDK supports 3 bridges out of the box. You can choose any of them.
45
45
46
46
The SDK supports 4 DEXes out of the box that is integrated with the various bridges.
47
47
48
-
Unfortunately, there is no way to select speicifc DEXes to use right now. The SDK will automatically select the best DEX to use based on the token pair and the amount being swapped.
48
+
Unfortunately, there is no way to select specific DEXes to use right now. The SDK will automatically select the best DEX to use based on the token pair and the amount being swapped.
49
49
50
50
- Paraswap (EVM)
51
51
- 1inch (EVM)
@@ -54,17 +54,17 @@ Unfortunately, there is no way to select speicifc DEXes to use right now. The SD
54
54
55
55
## Terminology
56
56
57
-
This section goes over some quick basic terminology that might be usefull.
57
+
This section goes over some quick basic terminology that might be useful.
58
58
59
59
### Source and Target
60
60
61
-
Source refers to what the user starts on. We use terms like source token, source chain etc. freely
61
+
The source refers to what the user starts on. We use terms like source token, source chain etc. freely
62
62
Target refers to where the user wants to end up in. We use terms like target token, target chain etc. freely
63
63
Note that Source and Target might well be the same chain or token.
64
64
65
65
### Accounts and Wallets and Signers
66
66
67
-
All these refers to an owner who has the ability to sign for a transaction. For the most part we use terms like source account, target account etc. freely.
67
+
All these refer to an owner who has the ability to sign for a transaction. For the most part, we use terms like source account, target account etc. freely.
68
68
Due to the proliferation of various packages in the space, we might inevitably refer to these accounts as wallets or signers, but know that they are referring to the same thing unless explicitly stated otherwise.
69
69
70
70
## API overview
@@ -73,8 +73,8 @@ Developers interact directly with a high level BridgeSdk that abstracts away the
73
73
74
74
### Goals
75
75
76
-
-Developer can allow users to easily bridge assets from one chain to another within their app
77
-
- Developers can easily get users to pay them from tokens on other chain while still receiving the expected assets on the target chain
76
+
-The developer can allow users to easily bridge assets from one chain to another within their app
77
+
- Developers can easily get users to pay them from tokens on another chain while still receiving the expected assets on the target chain
78
78
- Great DX for developers. Interruptions should be handled. Errors should be graceful and human readable.
0 commit comments