Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 306274e

Browse files
committed
Fix typos
1 parent 459e88f commit 306274e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Bridge Adapter Design Document
1+
# Unified Bridge Adapter
22

33
## Overview
44

55
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.
66

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).
88

99
### Unifying Existing Bridges
1010

1111
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.
1212

13-
### Leveraging Existing Decentralzed Exchanges (DEXes)
13+
### Leveraging Existing Decentralized Exchanges (DEXes)
1414

1515
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.
1717

1818
## Features
1919

@@ -45,7 +45,7 @@ The SDK supports 3 bridges out of the box. You can choose any of them.
4545

4646
The SDK supports 4 DEXes out of the box that is integrated with the various bridges.
4747

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.
4949

5050
- Paraswap (EVM)
5151
- 1inch (EVM)
@@ -54,17 +54,17 @@ Unfortunately, there is no way to select speicifc DEXes to use right now. The SD
5454

5555
## Terminology
5656

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.
5858

5959
### Source and Target
6060

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
6262
Target refers to where the user wants to end up in. We use terms like target token, target chain etc. freely
6363
Note that Source and Target might well be the same chain or token.
6464

6565
### Accounts and Wallets and Signers
6666

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.
6868
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.
6969

7070
## API overview
@@ -73,8 +73,8 @@ Developers interact directly with a high level BridgeSdk that abstracts away the
7373

7474
### Goals
7575

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
7878
- Great DX for developers. Interruptions should be handled. Errors should be graceful and human readable.
7979

8080
### React SDK

0 commit comments

Comments
 (0)