@galacticcouncil/sdk 0.0.1-beta.2 → 0.0.1-beta.20

package/README.md

@@ -0,0 +1,105 @@
+<h1><code>Galactic SDK</code></h1>
+<p>
+
+[![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.
+<br />
+<br />
+Table of content:
+
+- [Installation](#installation)
+- [Components](#components)
+  - [TradeRouter](#traderouter)
+  - [TradeExecutor](#tradeexecutor)
+- [Examples](#examples)
+- [Roadmap](#roadmap)
+- [Issue reporting](#issue-reporting)
+
+## Installation
+
+Install with [npm](https://www.npmjs.com/):
+
+`npm install @galacticcouncil/sdk`
+
+## Components
+
+### TradeRouter
+
+Off-chain optimization of orders across pools for best price execution. Router does not perform any on-chain transations.
+
+#### API
+
+```typescript
+getPools(): PoolBase[]
+getAllAssets(): PoolAsset[]
+getAssetPairs(token: string): PoolAsset[]
+getAllPaths(tokenIn: string, tokenOut: string): Hop[][]
+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
+```
+
+For type signature visit [types.ts](src/types.ts)<br />
+
+#### Usage
+
+```typescript
+// Import
+import { ApiPromise, WsProvider } from '@polkadot/api';
+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 PolkadotApiPoolService(api);
+const tradeRouter = new TradeRouter(poolService);
+
+// 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.
+
+### Run
+
+Run: `$ npx tsx ./test/script/examples/<examplePackage>/<exampleName>.ts` with valid example package & name.
+
+To demonstrate full working examples on real chain see [script](test/script/examples) section.
+
+## Roadmap
+
+Component list and current status ⬇️
+
+- 🧪 Done
+- 🛠 Work in progress
+- ⏳ Planning to build
+
+| Name          |  Type  |     |
+| ------------- | :----: | --: |
+| TradeRouter   |  API   |  🧪 |
+| TradeExecutor |  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/galacticcouncil/sdk/issues/new). It makes it easier to find & fix the problem accordingly.