@injectivelabs/networks 1.0.9 → 1.0.12

package/README.md

@@ -1,20 +1,72 @@
 # 🌟 Injective Protocol - Networks and Endpoints
 
----
+[![downloads](https://img.shields.io/npm/dm/@injectivelabs/tx-ts.svg)](https://www.npmjs.com/package/@injectivelabs/tx-ts)
+[![npm-version](https://img.shields.io/npm/v/@injectivelabs/tx-ts.svg)](https://www.npmjs.com/package/@injectivelabs/tx-ts)
+[![license](https://img.shields.io/npm/l/express.svg)]()
+
+_Accessing decentralized finance through TypeScript (for Web and Node environment)_
+
+`@injectivelabs/networks` is a TypeScript package for providing a pre-defined set of endpoints which can be used to fetch data from different data sources, broadcast transactions to sentry nodes, use the Tendermint RPC, etc, for different environments (Mainnet, Testnet, Devnet, etc).
+
+### 📚 Installation
 
-## 📚 Getting Started
+```bash
+yarn add @injectivelabs/networks
+```
+
+---
 
 ## 📖 Documentation
 
+This package exports an enum `Network` that developers can use for the different environments the Injective Chain can be run.
+
+There are two key functions exported from this package:
+
+- `export function getEndpointsForNetwork(network: Network): NetworkEndpoints`
+- `export function getNetworkInfo(network: Network): ChainInfo`
+
+The first one, `getEndpointsForNetwork` returns a pre-defined set of endpoints that can be used by the developers - depending on their need. Here is the interface that gets returned from this function:
+
+```ts
+export type NetworkEndpoints = {
+  exchangeApi: string // @deprecated - the grpc-web port of the exchange API service
+  indexerApi: string // the grpc-web port of the indexer API service
+  sentryGrpcApi: string // the grpc-web port of the sentry node
+  sentryHttpApi: string // the REST endpoint of the sentry node
+  tendermintApi?: string // the REST endpoint of the Tendermint RPC
+  chronosApi?: string // the REST endpoint of the chronos API service
+  exchangeWeb3GatewayApi?: string // the grpc-web port of the web3-gateway service API
+}
+```
+
+Lets explain these endpoints, and what do they mean:
+- `exchangeApi` / `indexerApi` is the grpc-web endpoint that we can use to connect to the `exchange/indexer` service which listens for events from the chain, processes the events and stores the data into a mongoDB so its easier and much more performant to serve that data than querying it straight from the chain itself,
+- `sentryGrpcApi` is the grpc-web endpoint that we can use to connect to a sentry node. A Sentry node is basically a read (and light) only version of the chain that we can use to query data directly from the chain.
+- `sentryHttpApi` is the REST endpoint that we can use to connect to a sentry node.
+- `tendermintApi` is the REST endpoint that we can use to connect to the Tendermint RPC,
+- `chronosApi` is the REST endpoint that we can use to connect to the Chronos API which is part of the `exchange/indexer` service which is used for rendering the TradingView chart and getting OHLC data for the markets,
+- `exchangeWeb3GatewayApi` is the grpc-web endpoint that we can use to connect to the web3-gateway which is part of the `exchange/indexer` service which is used for preparing and broadcasting Cosmos transactions using Ethereum native wallets + supports for fee delegation
+
+The `getNetworkInfo` exports these endpoints plus the `chainId` and the default `fee` for the `Network` we want.
+
 ---
 
 ## ⛑ Support
 
 Reach out to us at one of the following places!
 
-- Website at <a href="https://injectiveprotocol.com" target="_blank">`injectiveprotocol.com`</a>
+- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
 - Twitter at <a href="https://twitter.com/InjectiveLabs" target="_blank">`@InjectiveLabs`</a>
+- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Discord`</a>
+- Telegram at <a href="https://t.me/joininjective" target="_blank">`Telegram`</a>
 
 ---
 
 ## 🔓 License
+
+This software is licensed under the MIT license. See [LICENSE](./LICENSE) for full disclosure.
+
+<p>&nbsp;</p>
+<div align="center">
+  <sub><em>Powering the future of decentralized finance.</em></sub>
+</div>

package/dist/endpoints.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../src/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,eAAO,MAAM,sBAAsB,EAAE,gBAOpC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAOjC,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,gBAOxC,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAOpC,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,gBAOhC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAOjC,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAOpC,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,gBAOhC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAOjC,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,gBAO/B,CAAA"}
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../src/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE1C,eAAO,MAAM,sBAAsB,EAAE,gBAQpC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAQjC,CAAA;AAED,eAAO,MAAM,0BAA0B,EAAE,gBAQxC,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAQpC,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,gBAQhC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAQjC,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,gBAQpC,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,gBAQhC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,gBAQjC,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,gBAQ/B,CAAA"}

package/dist/endpoints.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.urlEndpointsLocal = exports.urlEndpointsDevnet1 = exports.urlEndpointsDevnet = exports.urlEndpointsTestnetK8s = exports.urlEndpointsTestnet = exports.urlEndpointsPublic = exports.urlEndpointsMainnetOld = exports.urlEndpointsMainnetStaging = exports.urlEndpointsMainnet = exports.urlEndpointsMainnetK8s = void 0;
 exports.urlEndpointsMainnetK8s = {
     exchangeApi: 'https://k8s-api.injective.network',
+    indexerApi: 'https://k8s-api.injective.network',
     chronosApi: 'https://k8s-api.injective.network',
     sentryGrpcApi: 'https://k8s-grpc.injective.network',
     tendermintApi: 'https://tm.injective.network',
@@ -11,6 +12,7 @@ exports.urlEndpointsMainnetK8s = {
 };
 exports.urlEndpointsMainnet = {
     exchangeApi: 'https://api.injective.network',
+    indexerApi: 'https://api.injective.network',
     chronosApi: 'https://api.injective.network',
     sentryGrpcApi: 'https://grpc.injective.network',
     tendermintApi: 'https://tm.injective.network',
@@ -19,6 +21,7 @@ exports.urlEndpointsMainnet = {
 };
 exports.urlEndpointsMainnetStaging = {
     exchangeApi: 'https://staging.api.injective.network',
+    indexerApi: 'https://staging.api.injective.network',
     chronosApi: 'https://staging.api.injective.network',
     sentryGrpcApi: 'https://staging.grpc.injective.network',
     tendermintApi: 'https://staging.tm.injective.network',
@@ -27,6 +30,7 @@ exports.urlEndpointsMainnetStaging = {
 };
 exports.urlEndpointsMainnetOld = {
     exchangeApi: 'https://api.injective.network',
+    indexerApi: 'https://api.injective.network',
     chronosApi: 'https://api.injective.network',
     sentryGrpcApi: 'https://grpc.injective.network',
     tendermintApi: 'https://tm.injective.network',
@@ -35,6 +39,7 @@ exports.urlEndpointsMainnetOld = {
 };
 exports.urlEndpointsPublic = {
     exchangeApi: 'https://public.api.injective.network',
+    indexerApi: 'https://public.api.injective.network',
     chronosApi: 'https://public.api.injective.network',
     sentryGrpcApi: 'https://public.grpc.injective.network',
     tendermintApi: 'https://tm.injective.network',
@@ -43,6 +48,7 @@ exports.urlEndpointsPublic = {
 };
 exports.urlEndpointsTestnet = {
     exchangeApi: 'https://testnet.api.injective.dev',
+    indexerApi: 'https://testnet.api.injective.dev',
     chronosApi: 'https://testnet.api.injective.dev',
     sentryGrpcApi: 'https://testnet.grpc.injective.dev',
     tendermintApi: 'https://testnet.tm.injective.dev',
@@ -51,6 +57,7 @@ exports.urlEndpointsTestnet = {
 };
 exports.urlEndpointsTestnetK8s = {
     exchangeApi: 'https://k8s.testnet.exchange.grpc-web.injective.network',
+    indexerApi: 'https://k8s.testnet.exchange.grpc-web.injective.network',
     chronosApi: 'https://k8s.testnet.exchange.grpc-web.injective.network',
     sentryGrpcApi: 'https://k8s.testnet.chain.grpc-web.injective.network',
     tendermintApi: 'https://k8s.testnet.tm.injective.network',
@@ -59,6 +66,7 @@ exports.urlEndpointsTestnetK8s = {
 };
 exports.urlEndpointsDevnet = {
     exchangeApi: 'https://devnet.api.injective.dev',
+    indexerApi: 'https://devnet.api.injective.dev',
     chronosApi: 'https://devnet.api.injective.dev',
     sentryGrpcApi: 'https://devnet.grpc.injective.dev',
     tendermintApi: 'https://devnet.tm.injective.dev',
@@ -67,6 +75,7 @@ exports.urlEndpointsDevnet = {
 };
 exports.urlEndpointsDevnet1 = {
     exchangeApi: 'https://devnet-1.api.injective.dev',
+    indexerApi: 'https://devnet-1.api.injective.dev',
     chronosApi: 'https://devnet-1.api.injective.dev',
     sentryGrpcApi: 'https://devnet-1.grpc.injective.dev',
     tendermintApi: 'https://devnet-1.tm.injective.dev',
@@ -75,6 +84,7 @@ exports.urlEndpointsDevnet1 = {
 };
 exports.urlEndpointsLocal = {
     exchangeApi: 'https://localhost:4444',
+    indexerApi: 'https://localhost:4444',
     chronosApi: 'https://localhost:4444',
     sentryGrpcApi: 'http://localhost:9091',
     tendermintApi: 'http://localhost:9091',

package/dist/endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../src/endpoints.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,mCAAmC;IAChD,UAAU,EAAE,mCAAmC;IAC/C,aAAa,EAAE,oCAAoC;IACnD,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,mCAAmC;IAClD,sBAAsB,EAAE,uCAAuC;CAChE,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,+BAA+B;IAC5C,UAAU,EAAE,+BAA+B;IAC3C,aAAa,EAAE,gCAAgC;IAC/C,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,+BAA+B;IAC9C,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,0BAA0B,GAAqB;IAC1D,WAAW,EAAE,uCAAuC;IACpD,UAAU,EAAE,uCAAuC;IACnD,aAAa,EAAE,wCAAwC;IACvD,aAAa,EAAE,sCAAsC;IACrD,aAAa,EAAE,uCAAuC;IACtD,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,+BAA+B;IAC5C,UAAU,EAAE,+BAA+B;IAC3C,aAAa,EAAE,gCAAgC;IAC/C,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,+BAA+B;IAC9C,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,kBAAkB,GAAqB;IAClD,WAAW,EAAE,sCAAsC;IACnD,UAAU,EAAE,sCAAsC;IAClD,aAAa,EAAE,uCAAuC;IACtD,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,sCAAsC;IACrD,sBAAsB,EAAE,+CAA+C;CACxE,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,mCAAmC;IAChD,UAAU,EAAE,mCAAmC;IAC/C,aAAa,EAAE,oCAAoC;IACnD,aAAa,EAAE,kCAAkC;IACjD,aAAa,EAAE,mCAAmC;IAClD,sBAAsB,EAAE,4CAA4C;CACrE,CAAA;AAEY,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,yDAAyD;IACtE,UAAU,EAAE,yDAAyD;IACrE,aAAa,EAAE,sDAAsD;IACrE,aAAa,EAAE,0CAA0C;IACzD,aAAa,EAAE,2CAA2C;IAC1D,sBAAsB,EAAE,gDAAgD;CACzE,CAAA;AAEY,QAAA,kBAAkB,GAAqB;IAClD,WAAW,EAAE,kCAAkC;IAC/C,UAAU,EAAE,kCAAkC;IAC9C,aAAa,EAAE,mCAAmC;IAClD,aAAa,EAAE,iCAAiC;IAChD,aAAa,EAAE,kCAAkC;IACjD,sBAAsB,EAAE,sCAAsC;CAC/D,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,oCAAoC;IACjD,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,qCAAqC;IACpD,aAAa,EAAE,mCAAmC;IAClD,aAAa,EAAE,oCAAoC;IACnD,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,iBAAiB,GAAqB;IACjD,WAAW,EAAE,wBAAwB;IACrC,UAAU,EAAE,wBAAwB;IACpC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;IACtC,sBAAsB,EAAE,wBAAwB;CACjD,CAAA"}
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../src/endpoints.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,mCAAmC;IAChD,UAAU,EAAE,mCAAmC;IAC/C,UAAU,EAAE,mCAAmC;IAC/C,aAAa,EAAE,oCAAoC;IACnD,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,mCAAmC;IAClD,sBAAsB,EAAE,uCAAuC;CAChE,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,+BAA+B;IAC5C,UAAU,EAAE,+BAA+B;IAC3C,UAAU,EAAE,+BAA+B;IAC3C,aAAa,EAAE,gCAAgC;IAC/C,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,+BAA+B;IAC9C,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,0BAA0B,GAAqB;IAC1D,WAAW,EAAE,uCAAuC;IACpD,UAAU,EAAE,uCAAuC;IACnD,UAAU,EAAE,uCAAuC;IACnD,aAAa,EAAE,wCAAwC;IACvD,aAAa,EAAE,sCAAsC;IACrD,aAAa,EAAE,uCAAuC;IACtD,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,+BAA+B;IAC5C,UAAU,EAAE,+BAA+B;IAC3C,UAAU,EAAE,+BAA+B;IAC3C,aAAa,EAAE,gCAAgC;IAC/C,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,+BAA+B;IAC9C,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,kBAAkB,GAAqB;IAClD,WAAW,EAAE,sCAAsC;IACnD,UAAU,EAAE,sCAAsC;IAClD,UAAU,EAAE,sCAAsC;IAClD,aAAa,EAAE,uCAAuC;IACtD,aAAa,EAAE,8BAA8B;IAC7C,aAAa,EAAE,sCAAsC;IACrD,sBAAsB,EAAE,+CAA+C;CACxE,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,mCAAmC;IAChD,UAAU,EAAE,mCAAmC;IAC/C,UAAU,EAAE,mCAAmC;IAC/C,aAAa,EAAE,oCAAoC;IACnD,aAAa,EAAE,kCAAkC;IACjD,aAAa,EAAE,mCAAmC;IAClD,sBAAsB,EAAE,4CAA4C;CACrE,CAAA;AAEY,QAAA,sBAAsB,GAAqB;IACtD,WAAW,EAAE,yDAAyD;IACtE,UAAU,EAAE,yDAAyD;IACrE,UAAU,EAAE,yDAAyD;IACrE,aAAa,EAAE,sDAAsD;IACrE,aAAa,EAAE,0CAA0C;IACzD,aAAa,EAAE,2CAA2C;IAC1D,sBAAsB,EAAE,gDAAgD;CACzE,CAAA;AAEY,QAAA,kBAAkB,GAAqB;IAClD,WAAW,EAAE,kCAAkC;IAC/C,UAAU,EAAE,kCAAkC;IAC9C,UAAU,EAAE,kCAAkC;IAC9C,aAAa,EAAE,mCAAmC;IAClD,aAAa,EAAE,iCAAiC;IAChD,aAAa,EAAE,kCAAkC;IACjD,sBAAsB,EAAE,sCAAsC;CAC/D,CAAA;AAEY,QAAA,mBAAmB,GAAqB;IACnD,WAAW,EAAE,oCAAoC;IACjD,UAAU,EAAE,oCAAoC;IAChD,UAAU,EAAE,oCAAoC;IAChD,aAAa,EAAE,qCAAqC;IACpD,aAAa,EAAE,mCAAmC;IAClD,aAAa,EAAE,oCAAoC;IACnD,sBAAsB,EAAE,wCAAwC;CACjE,CAAA;AAEY,QAAA,iBAAiB,GAAqB;IACjD,WAAW,EAAE,wBAAwB;IACrC,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE,wBAAwB;IACpC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;IACtC,aAAa,EAAE,uBAAuB;IACtC,sBAAsB,EAAE,wBAAwB;CACjD,CAAA"}

package/dist/types.d.ts

@@ -13,6 +13,7 @@ export declare enum Network {
 }
 export declare type NetworkEndpoints = {
     exchangeApi: string;
+    indexerApi: string;
     sentryGrpcApi: string;
     sentryHttpApi: string;
     tendermintApi?: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,UAAU,eAAe;CAC1B;AAED,oBAAY,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,oBAAY,YAAY,GAAG,gBAAgB,CAAA,CAAC,iBAAiB;AAE7D,oBAAY,SAAS,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,UAAU,eAAe;CAC1B;AAED,oBAAY,gBAAgB,GAAG;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,oBAAY,YAAY,GAAG,gBAAgB,CAAA,CAAC,iBAAiB;AAE7D,oBAAY,SAAS,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@injectivelabs/networks",
   "description": "Endpoints, networks, etc. Can be reused throughout Injective's projects.",
-  "version": "1.0.9",
+  "version": "1.0.12",
   "license": "MIT",
   "author": {
     "name": "Bojan Angjelkoski",
@@ -31,10 +31,10 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
-    "@injectivelabs/exceptions": "^1.0.6",
-    "@injectivelabs/utils": "^1.0.9",
+    "@injectivelabs/exceptions": "^1.0.7",
+    "@injectivelabs/utils": "^1.0.10",
     "link-module-alias": "^1.2.0",
     "shx": "^0.3.2"
   },
-  "gitHead": "30ee2f440a235dc01a4e44089df6a18379a5c98d"
+  "gitHead": "451f02c77bcd90228c81df412db4c65e69d6093d"
 }