@galacticcouncil/sdk 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -6
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,13 +26,9 @@ Install with [npm](https://www.npmjs.com/):
|
|
|
26
26
|
|
|
27
27
|
## Components
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
### Router
|
|
30
30
|
|
|
31
|
-
Off-chain routing, build to find the
|
|
32
|
-
|
|
33
|
-
### TradeRouter
|
|
34
|
-
|
|
35
|
-
Off-chain optimization of orders across pools for best price execution. TradeRouter does not perform any on-chain transations.
|
|
31
|
+
Off-chain routing, build to find the most suitable routes across the the pools. Building block for TradeRouter.
|
|
36
32
|
|
|
37
33
|
#### API
|
|
38
34
|
|
|
@@ -41,6 +37,15 @@ getPools(): PoolBase[]
|
|
|
41
37
|
getAllAssets(): PoolAsset[]
|
|
42
38
|
getAssetPairs(token: string): PoolAsset[]
|
|
43
39
|
getAllPaths(tokenIn: string, tokenOut: string): Hop[][]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### TradeRouter
|
|
43
|
+
|
|
44
|
+
Off-chain optimization of orders across pools for best price execution. TradeRouter does not perform any on-chain transations.
|
|
45
|
+
|
|
46
|
+
#### API
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
44
49
|
getBestSpotPrice(tokenIn: string, tokenOut: string): Amount
|
|
45
50
|
getBestSell(tokenIn: string, tokenOut: string, amountIn: BigNumber | number | string): Trade
|
|
46
51
|
getBestBuy(tokenIn: string, tokenOut: string, amountOut: BigNumber | number | string): Trade
|