@galacticcouncil/sdk 0.0.1-beta.9 → 0.0.2

package/README.md

@@ -3,7 +3,6 @@
 
 [![npm version](https://img.shields.io/npm/v/@galacticcouncil/sdk.svg)](https://www.npmjs.com/package/@galacticcouncil/sdk)
 ![Coverage](./badges/coverage-jest%20coverage.svg)
-[![CodeFactor](https://www.codefactor.io/repository/github/galacticcouncil/sdk/badge)](https://www.codefactor.io/repository/github/galacticcouncil/sdk)
 
 </p>
 Galactic SDK is collection of components crafted to ease Basilisk & HydraDX chains integration.
@@ -27,9 +26,9 @@ Install with [npm](https://www.npmjs.com/):
 
 ## Components
 
-### TradeRouter
+### Router
 
-Off-chain optimization of orders across pools for best price execution. Router does not perform any on-chain transations.
+Off-chain routing, build to find the most suitable routes across the the pools. Building block for TradeRouter.
 
 #### API
 
@@ -38,6 +37,16 @@ getPools(): PoolBase[]
 getAllAssets(): PoolAsset[]
 getAssetPairs(token: string): PoolAsset[]
 getAllPaths(tokenIn: string, tokenOut: string): Hop[][]
+```
+
+### TradeRouter
+
+Off-chain optimization of orders across pools for best price execution. TradeRouter does not perform any on-chain transations.
+
+#### API
+
+```typescript
+getBestSpotPrice(tokenIn: string, tokenOut: string): Amount
 getBestSell(tokenIn: string, tokenOut: string, amountIn: BigNumber | number | string): Trade
 getBestBuy(tokenIn: string, tokenOut: string, amountOut: BigNumber | number | string): Trade
 ```
@@ -49,27 +58,21 @@ For type signature visit [types.ts](src/types.ts)<br />
 ```typescript
 // Import
 import { ApiPromise, WsProvider } from '@polkadot/api';
-import { TradeRouter, PolkadotPoolService } from '@galacticcouncil/sdk';
+import { TradeRouter, PolkadotApiPoolService } from '@galacticcouncil/sdk';
 
 // Initialize Polkadot API
 const wsProvider = new WsProvider('wss://rpc.basilisk.cloud');
 const api = await ApiPromise.create({ provider: wsProvider });
 
-// Initialize Router
-const poolService = new PolkadotPoolService(api);
-const tradeRouter = new TradeRouter(poolService);
+// Initialize Trade Router
+const poolService = new PolkadotApiPoolService(api);
+const tradeRouter = new TradeRouter(poolService, { includeOnly: [PoolType.XYK] });
 
 // Do something
 const result = await tradeRouter.getAllAssets();
 console.log(result);
 ```
 
-### TradeExecutor
-
-On-chain transaction executor using data from router to perform best possible trade.
-
-Not supported yet. 🛠
-
 ## Examples
 
 SDK Examples and testing helpers.
@@ -88,17 +91,17 @@ Component list and current status ⬇️
 - 🛠 Work in progress
 - ⏳ Planning to build
 
-| Name          |  Type  |     |
-| ------------- | :----: | --: |
-| TradeRouter   |  API   |  🧪 |
-| TradeExecutor |  API   |   🛠 |
-| Polkadot      | Client |  🧪 |
-| Capi          | Client |  ⏳ |
-| XYK           |  Pool  |  🧪 |
-| LBP           |  Pool  |  ⏳ |
-| Stable        |  Pool  |  ⏳ |
-| Omni          |  Pool  |  ⏳ |
+| Name        |  Type  |     |
+| ----------- | :----: | --: |
+| Router      |  API   |  🧪 |
+| TradeRouter |  API   |  🧪 |
+| Polkadot    | Client |  🧪 |
+| Capi        | Client |  ⏳ |
+| XYK         |  Pool  |  🧪 |
+| Omni        |  Pool  |  🧪 |
+| LBP         |  Pool  |   🛠 |
+| Stable      |  Pool  |  ⏳ |
 
 ## Issue reporting
 
-In case of unexpected sdk behaviour, please create well-written issue [here](https://https://github.com/nohaapav/router-sdk/issues/new). It makes it easier to find & fix the problem accordingly.
+In case of unexpected sdk behaviour, please create well-written issue [here](https://https://github.com/galacticcouncil/sdk/issues/new). It makes it easier to find & fix the problem accordingly.