@galacticcouncil/sdk 0.5.2 → 0.6.0

package/{dist → build}/types/index.d.ts

@@ -1,9 +1,6 @@
 export { Router, TradeRouter } from './api';
 export * from './pool';
 export * from './client';
-export * from './registry';
-export * from './storage';
-export * from './wallet';
 export * from './types';
 export * from './errors';
 export * from './consts';

package/package.json

@@ -1,54 +1,63 @@
 {
   "name": "@galacticcouncil/sdk",
-  "version": "0.5.2",
-  "private": false,
-  "description": "Galactic SDK",
-  "author": "Pavol Noha <palo@hydradx.io>",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/types/index.d.ts",
-  "scripts": {
-    "build": "node ./esbuild.mjs && tsc --emitDeclarationOnly --outDir dist/types/",
-    "cleanup": "rimraf out && rimraf dist",
-    "release": "standard-version --tag-prefix=''",
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "pckg:build": "npm run cleanup && npm run build",
-    "pckg:beta": "npm run pckg:build && npm publish --tag beta",
-    "pckg:release": "npm run pckg:build && standard-version --tag-prefix=''",
-    "pckg:publish": "git push --follow-tags origin master && npm publish",
-    "xcmgr:sync": "node ./xcmgr.sync.mjs"
+  "version": "0.6.0",
+  "description": "Galactic off-chain routing & optimization of orders across pools for best price execution",
+  "author": "GalacticCouncil",
+  "repository": {
+    "directory": "packages/sdk",
+    "type": "git",
+    "url": "git+https://github.com/galacticcouncil/sdk.git"
+  },
+  "keywords": [
+    "hydradx",
+    "basilisk",
+    "router",
+    "sdk"
+  ],
+  "bugs": {
+    "url": "https://github.com/galacticcouncil/sdk/issues"
   },
-  "standard-version": {
-    "skip": {
-      "changelog": true
-    }
+  "files": [
+    "build"
+  ],
+  "main": "./build/index.cjs",
+  "module": "./build/index.mjs",
+  "types": "./build/types/index.d.ts",
+  "scripts": {
+    "build": "node ./esbuild.config.mjs",
+    "build:watch": "npm run build -- --watch",
+    "postbuild": "tsc --emitDeclarationOnly --outDir build/types/",
+    "clean": "rimraf build",
+    "link": "npm ln",
+    "test": "jest"
   },
   "devDependencies": {
-    "@galacticcouncil/api-augment": "^0.0.4",
-    "@types/jest": "^28.1.8",
-    "es-jest": "^2.0.0",
-    "esbuild": "^0.14.53",
-    "esbuild-plugin-wasm": "^1.0.0",
-    "fs-extra": "^10.1.0",
-    "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "standard-version": "^9.5.0",
-    "ts-jest": "^28.0.8",
-    "ts-node": "^10.9.1",
-    "tsx": "^3.8.2",
-    "typescript": "^4.7.4"
+    "@galacticcouncil/api-augment": "^0.0.4"
   },
   "dependencies": {
-    "@galacticcouncil/math-lbp": "^0.1.3",
-    "@galacticcouncil/math-omnipool": "^0.1.3",
-    "@galacticcouncil/math-xyk": "^0.1.3",
+    "@galacticcouncil/math-lbp": "^0.2.0",
+    "@galacticcouncil/math-omnipool": "^0.2.0",
+    "@galacticcouncil/math-xyk": "^0.2.0",
     "@thi.ng/cache": "^2.1.35",
     "bignumber.js": "^9.1.0",
     "lodash.clonedeep": "^4.5.0"
   },
   "peerDependencies": {
     "@polkadot/api": "^10.9.1",
-    "ethers": "^6.0.5"
+    "@polkadot/api-augment": "^10.9.1",
+    "@polkadot/api-derive": "^10.9.1",
+    "@polkadot/api-base": "^10.9.1",
+    "@polkadot/rpc-augment": "^10.9.1",
+    "@polkadot/rpc-core": "^10.9.1",
+    "@polkadot/rpc-provider": "^10.9.1",
+    "@polkadot/types": "^10.9.1",
+    "@polkadot/types-augment": "^10.9.1",
+    "@polkadot/types-codec": "^10.9.1",
+    "@polkadot/types-create": "^10.9.1",
+    "@polkadot/types-known": "^10.9.1",
+    "@polkadot/keyring": "^12.3.2",
+    "@polkadot/util": "^12.3.2",
+    "@polkadot/util-crypto": "^12.3.2",
+    "ethers": "^5.7.2"
   }
 }

package/README.md

@@ -1,134 +0,0 @@
-# Galactic SDK
-
-[![npm version](https://img.shields.io/npm/v/@galacticcouncil/sdk.svg)](https://www.npmjs.com/package/@galacticcouncil/sdk)
-![Coverage](./badges/coverage-jest%20coverage.svg)
-
-</p>
-Galactic SDK is collection of components crafted to ease Basilisk & HydraDX chains integration.
-<br />
-<br />
-Table of content:
-
-- [Installation](#installation)
-- [Components](#components)
-  - [Router](#router)
-  - [TradeRouter](#traderouter)
-- [Examples](#examples)
-- [Roadmap](#roadmap)
-- [Issue reporting](#issue-reporting)
-
-## Installation
-
-Install with [npm](https://www.npmjs.com/):
-
-`npm install @galacticcouncil/sdk`
-
-## Components
-
-### Router
-
-Off-chain routing, build to find the most suitable routes across the pools. Building block for TradeRouter.
-
-#### API
-
-```typescript
-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
-```
-
-For type signature visit [types.ts](src/types.ts)<br />
-
-#### Usage
-
-```typescript
-// Import
-import { ApiPromise, WsProvider } from '@polkadot/api';
-import { TradeRouter, PoolService, PoolType } from '@galacticcouncil/sdk';
-
-// Initialize Polkadot API
-const wsProvider = new WsProvider('wss://rpc.basilisk.cloud');
-const api = await ApiPromise.create({ provider: wsProvider });
-
-// Initialize Trade Router
-const poolService = new PoolService(api);
-const tradeRouter = new TradeRouter(poolService, { includeOnly: [PoolType.XYK] });
-
-// Do something
-const result = await tradeRouter.getAllAssets();
-console.log(result);
-```
-
-## 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  |     |
-| ----------- | :----: | --: |
-| Router      |  API   |  🧪 |
-| TradeRouter |  API   |  🧪 |
-| Polkadot    | Client |  🧪 |
-| Capi        | Client |  ⏳ |
-| XYK         |  Math  |  🧪 |
-| XYK         |  Pool  |  🧪 |
-| Omni        |  Math  |  🧪 |
-| Omni        |  Pool  |  🧪 |
-| LBP         |  Math  |  🧪 |
-| LBP         |  Pool  |   🛠 |
-| Stable      |  Math  |  ⏳ |
-| Stable      |  Pool  |  ⏳ |
-
-## Development and Build
-
-### Requirements
-
-- [Node.js](https://nodejs.org/) (**version 18 or higher**)
-
-### Build & Release
-
-```sh
-npm install # to install all dependencies
-npm run pckg:release # to release patch version (default)
-npm run pckg:publish # to publish npm package
-```
-
-#### Other
-
-To release minor or major version of the SDK use following commands.
-
-```sh
-npm run pckg:release -- --release-as minor # Release minor version. E.g. 1.0.23 -> 1.1.0
-npm run pckg:release -- --release-as major # Release major version. E.g. 1.0.23 -> 2.0.0
-npm run pckg:release -- --release-as 1.1.0 # Release specific version (1.1.0)
-```
-
-## 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.