feat: initial setup for the spot consumer

InjectiveLabs · Apr 10, 2021 · 78dc6a7 · 78dc6a7
1 parent 22c6807
commit 78dc6a7
Show file tree

Hide file tree

Showing 36 changed files with 697 additions and 254 deletions.
diff --git a/packages/chronos-consumer/.npmignore b/packages/chronos-consumer/.npmignore
diff --git a/packages/chronos-consumer/CHANGELOG.md b/packages/chronos-consumer/CHANGELOG.md
diff --git a/packages/chronos-consumer/README.md b/packages/chronos-consumer/README.md
diff --git a/packages/chronos-consumer/jest.config.js b/packages/chronos-consumer/jest.config.js
diff --git a/packages/chronos-consumer/package.json b/packages/chronos-consumer/package.json
diff --git a/packages/chronos-consumer/src/index.ts b/packages/chronos-consumer/src/index.ts
diff --git a/packages/chronos-consumer/tsconfig.build.json b/packages/chronos-consumer/tsconfig.build.json
diff --git a/packages/chronos-consumer/tsconfig.json b/packages/chronos-consumer/tsconfig.json
diff --git a/packages/exchange-consumer/CHANGELOG.md b/packages/exchange-consumer/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.29](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/exchange-consumer@0.0.28...@injectivelabs/exchange-consumer@0.0.29) (2021-04-10)
+
+### Features
+
+* initial setup for the spot consumer ([8628cd9](https://github.com/InjectiveLabs/injective-ts/commit/8628cd991927250448bf466b938beb9bff58e28f))
+
 ## [0.0.28](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/exchange-consumer@0.0.27...@injectivelabs/exchange-consumer@0.0.28) (2021-04-08)
 
 ### Bug Fixes

diff --git a/packages/exchange-consumer/package.json b/packages/exchange-consumer/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@injectivelabs/exchange-consumer",
   "description": "Interacting with our Exchange API made easy. Can be reused throughout Injective's projects.",
-  "version": "0.0.28",
+  "version": "0.0.29",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,7 +31,7 @@
     "@improbable-eng/grpc-web-node-http-transport": "^0.14.0",
     "@injectivelabs/chain-api": "^1.4.3",
     "@injectivelabs/exceptions": "^0.0.18",
-    "@injectivelabs/exchange-api": "^1.0.13",
+    "@injectivelabs/exchange-api": "^2.0.0",
     "@injectivelabs/ts-types": "^0.0.15",
     "@injectivelabs/tx-utils": "^0.0.3",
     "@injectivelabs/utils": "^0.0.23",

diff --git a/packages/graph-consumer/.npmignore b/packages/graph-consumer/.npmignore
diff --git a/packages/graph-consumer/CHANGELOG.md b/packages/graph-consumer/CHANGELOG.md
diff --git a/packages/graph-consumer/README.md b/packages/graph-consumer/README.md
diff --git a/packages/graph-consumer/jest.config.js b/packages/graph-consumer/jest.config.js
diff --git a/packages/graph-consumer/package.json b/packages/graph-consumer/package.json
diff --git a/packages/graph-consumer/src/index.ts b/packages/graph-consumer/src/index.ts
diff --git a/packages/graph-consumer/tsconfig.build.json b/packages/graph-consumer/tsconfig.build.json
diff --git a/packages/graph-consumer/tsconfig.json b/packages/graph-consumer/tsconfig.json
diff --git a/packages/spot-consumer/CHANGELOG.md b/packages/spot-consumer/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.0.7](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/spot-consumer@0.0.6...@injectivelabs/spot-consumer@0.0.7) (2021-04-10)
+
+### Features
+
+* initial setup for the spot consumer ([8628cd9](https://github.com/InjectiveLabs/injective-ts/commit/8628cd991927250448bf466b938beb9bff58e28f))
+
 ## [0.0.6](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/spot-consumer@0.0.5...@injectivelabs/spot-consumer@0.0.6) (2021-03-14)
 
 **Note:** Version bump only for package @injectivelabs/spot-consumer

diff --git a/packages/spot-consumer/README.md b/packages/spot-consumer/README.md
@@ -1,11 +1,47 @@
-# 🌟 Injective Protocol - Spot API
+# 🌟 Injective Protocol - Web3 Strategy
+
+[![downloads](https://img.shields.io/npm/dm/@injectivelabs/spot-consumer.svg)](https://www.npmjs.com/package/@injectivelabs/spot-consumer)
+[![npm-version](https://img.shields.io/npm/v/@injectivelabs/spot-consumer.svg)](https://www.npmjs.com/package/@injectivelabs/spot-consumer)
+[![license](https://img.shields.io/npm/l/express.svg)]()
+
+_A convenient way to consume Spot Market and Subaccounts API._
 
 ---
 
-## 📚 Getting Started
+## 📚 Installation
+
+```bash
+yarn add @injectivelabs/spot-consumer
+```
 
 ## 📖 Documentation
 
+This package is a TypeScript wrapper around the GRPC API provided by our Injective Exchange for spot markets and subaccounts.
+
+The package is split between two separate concerns, "consumers" and "transformers". With the "consumers" we are making GRPC API calls to the Injective Exchange, and with the "transformers" we are transforming the data from a protobuf message to a plain TypeScript object that can be used more conveniently.
+
+## 📖 Example Usage
+
+```ts
+// file: index.ts
+import { SpotMarketConsumer, SpotMarketTransformer } from "@injectivelabs/spot-consumer"
+
+const endpoint = '' // Exchange API endpoint
+const spotMarketConsumer = new SpotMarketConsumer(endpoint)
+
+(async() => {
+  const markets = SpotMarketTransformer.marketsToUiMarkets(await spotMarketConsumer.fetchMarkets()) // returns UiSpotMarket[]
+
+  console.log(markets)
+})()
+```
+
+---
+
+## 📜 Contribution
+
+**Contribution guides and practices will be available once there is a stable foundation of the whole package set within the `injective-ts` repo.**
+
 ---
 
 ## ⛑ Support
@@ -18,3 +54,5 @@ Reach out to us at one of the following places!
 ---
 
 ## 🔓 License
+
+[![License](https://img.shields.io/:license-mit-blue.svg?style=flat-square)](https://badges.mit-license.org)
diff --git a/packages/spot-consumer/package.json b/packages/spot-consumer/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@injectivelabs/spot-consumer",
   "description": "Spot Trading on Injective Protocol made easy. Can be reused throughout Injective's projects.",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,6 +27,12 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
+    "@improbable-eng/grpc-web": "^0.14.0",
+    "@improbable-eng/grpc-web-node-http-transport": "^0.14.0",
+    "@injectivelabs/exceptions": "^0.0.18",
+    "@injectivelabs/exchange-api": "^2.0.0",
+    "@injectivelabs/ts-types": "^0.0.15",
+    "@injectivelabs/utils": "^0.0.23",
     "link-module-alias": "^1.2.0",
     "shx": "^0.3.2"
   },