Access Limitless DeFi Markets with Zero Barriers.
injective-ts is a TypeScript monorepo that contains packages which can be used to interact with Injective from a Node.js or browser environments and which provide simple abstractions over core data structures, serialization, key management, and API request generation, etc. The packages can be found in the packages folder and each package is a npm module that is published on the npm registry.
To get a sense of the packages and their functionality, we are going to list them a provide a simple explanation about their core functionality and how they can be used by developers to build applications on top Injective.
Detailed documentation and usage can be found within each package's respective folder in the packages folder
-
@injectivelabs/sdk-tsis the sdk powerhouse that provides easily accessing data from any data source (chain, api), regardless of the type of access (grpc, rest), and provides a way to easily compose Messages, pack them into Transactions that can be broadcasted to Injective. It also provides a way to prepare and broadcast transactions for Injective -
@injectivelabs/wallet-tsprovides a way for different wallet provides to be used to prepare, sign and broadcast transactions on the Injective Chain. There are also some implementations and utility functions for specific blockchains that are not exported as default from the package but they can be reused based on the developers needs. -
@injectivelabs/contractsis a npm package used for providing an abstraction over some Ethereum smart contracts that can be useful while building applications on top of Injective. These include theERC20Contract, and thePeggyContractwhich is the contract deployed on the Ethereum Network used for the Peggy bridge between Ethereum and Injective. It can also be used to fetch some common contract addresses based on theethereumChainId -
@injectivelabs/exceptionsprovides some exception classes that can be used to provide more context about the Error type thrown from within the applications built on top of Injective -
@injectivelabs/networksprovides a way for developers to get pre-defined endpoints for accessing the sentry nodes (the read-only versions of the chain, which are used to serve data directly from Injective), the exchange api (an indexer that indexes events from the Injective Chain and stores the data in a MongoDB for easier access), tendermint rpc (the default rpc for blockchains built using the CosmosSDK), etc. -
@injectivelabs/sdk-ui-tsprovides some abstractions and mappers (transformers) which can transform the data from data sources (whether its the chain itself or the API) so its more convenient to use them while building UIs. -
@injectivelabs/token-metadataprovides token metadata information for denoms that are used on the Injective chain. Denoms are represented in a different format depending on the source they were bridged over to the Injective Chain (peggy, ibc, etc), so this package provides a way to fetch token meta data about these denoms (name, symbol, decimals, etc). -
@injectivelabs/token-utilsprovides some abstractions over some utilities for denoms that are on the Injective chain (ex: fetching their usd price, etc) -
@injectivelabs/ts-typesprovides some commonly used TypeScript types/enums -
@injectivelabs/utilsprovides some commonly used utility functions and classes
General contribution guidelines can be found on the Contributing page. There can be a package-specific contribution guides, please make sure you read them before you open a PR.
Reach out to us at one of the following places!
- Website at
injective.com - Twitter at
@Injective - Discord at
Discord - Telegram at
Telegram
Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
Originally released by Injective Labs Inc. under:
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/