add doc to inj

libs/injectivejs/README.md

@@ -1,7 +1,8 @@
 # InjectiveJS
 
 <p align="center">
-  <img src="https://user-images.githubusercontent.com/545047/193426489-d5d3c9a9-d738-43a0-a628-b8b4f1a8034b.png" width="80">
+  <img src="https://user-images.githubusercontent.com/545047/193426489-d5d3c9a9-d738-43a0-a628-b8b4f1a8034b.png" width="80"><br />
+    Building the future of decentralized exchange
 </p>
 
 <p align="center" width="100%">
@@ -12,7 +13,377 @@
    <a href="https://github.com/cosmology-tech/interchainjs/blob/main/LICENSE-Apache"><img height="20" src="https://img.shields.io/badge/license-Apache-blue.svg"></a>
 </p>
 
-Functionalities(Tx, Query) generated by Telescope.
+## install
+
+```sh
+npm install injectivejs
+```
+
+## Table of contents
+
+- [InjectiveJS](#injectivejs)
+  - [Install](#install)
+  - [Table of contents](#table-of-contents)
+- [Usage](#usage)
+  - [RPC Clients](#rpc-clients)
+  - [Tx Helpers](#tx-helpers)
+    - Injective
+      - [Auction](#auction-messages)
+      - [Exchange](#exchange-messages)
+      - [Insurance](#insurance-messages)
+      - [OCR](#ocr-messages)
+      - [Oracle](#oracle-messages)
+      - [Peggy](#peggy-messages)
+    - Cosmos, CosmWasm, and IBC
+      - [CosmWasm](#cosmwasm-messages)
+      - [IBC](#ibc-messages)
+      - [Cosmos](#cosmos-messages)
+- [Wallets and Signers](#connecting-with-wallets-and-signing-messages)
+  - [Stargate Client](#initializing-the-stargate-client)
+  - [Creating Signers](#creating-signers)
+  - [Broadcasting Messages](#broadcasting-messages)
+- [Advanced Usage](#advanced-usage)
+- [Developing](#developing)
+- [Credits](#credits)
+
+## Usage
+
+### RPC Clients
+
+```js
+import { createQueryRpc } from "@interchainjs/cosmos/utils";
+import { createGetAllBalances } from "injectivejs/cosmos/bank/v1beta1/query.rpc.func";
+import { createGetExchangeBalances } from "injectivejs/injective/exchange/v1beta1/query.rpc.func";
+
+{ getRpcEndpoint } = useChain("osmosis");
+
+const endpoint = await getRpcEndpoint();
+const rpc = createQueryRpc(endpoint);
+
+// get the tree shakable helper functions using the rpc client
+const getAllBalances = createGetAllBalances(rpc);
+
+// now you can query the cosmos modules
+const balance = await getAllBalances({
+  address: "inj1addresshere",
+});
+
+// you can also query the injective modules
+const getExchangeBalances = createGetExchangeBalances(rpc);
+const exchangeBalance = await getExchangeBalances({});
+```
+
+### Tx Helpers
+
+For tx messages, there're helper functions to sign and broadcast messages:
+
+```js
+import {
+  createDeposit,
+  createLiquidatePosition,
+  createActivateStakeGrant,
+} from "injectivejs/injective/exchange/v1beta1/tx.rpc.func";
+```
+
+#### Auction Messages
+
+```js
+import { createBid } from "injectivejs/injective/auction/v1beta1/tx.rpc.func";
+```
+
+#### Exchange Messages
+
+```js
+import {
+  createActivateStakeGrant,
+  createAdminUpdateBinaryOptionsMarket,
+  createAuthorizeStakeGrants,
+  createBatchCancelBinaryOptionsOrders,
+  createBatchCancelDerivativeOrders,
+  createBatchCancelSpotOrders,
+  createBatchCreateDerivativeLimitOrders,
+  createBatchCreateSpotLimitOrders,
+  createBatchUpdateOrders,
+  createCancelBinaryOptionsOrder,
+  createCancelDerivativeOrder,
+  createCancelSpotOrder,
+  createCreateBinaryOptionsLimitOrder,
+  createCreateBinaryOptionsMarketOrder,
+  createCreateDerivativeLimitOrder,
+  createCreateDerivativeMarketOrder,
+  createCreateSpotLimitOrder,
+  createCreateSpotMarketOrder,
+  createDecreasePositionMargin,
+  createDeposit,
+  createEmergencySettleMarket,
+  createExternalTransfer,
+  createIncreasePositionMargin,
+  createInstantBinaryOptionsMarketLaunch,
+  createInstantExpiryFuturesMarketLaunch,
+  createInstantPerpetualMarketLaunch,
+  createInstantSpotMarketLaunch,
+  createLiquidatePosition,
+  createPrivilegedExecuteContract,
+  createRewardsOptOut,
+  createSubaccountTransfer,
+  createUpdateDerivativeMarket,
+  createUpdateParams,
+  createUpdateSpotMarket,
+  createWithdraw,
+} from "injectivejs/injective/exchange/v1beta1/tx.rpc.func";
+```
+
+#### Insurance Messages
+
+```js
+import {
+  createCreateInsuranceFund,
+  createRequestRedemption,
+  createUnderwrite,
+} from "injectivejs/injective/insurance/v1beta1/tx.rpc.func";
+```
+
+#### OCR Messages
+
+```js
+import {
+  createAcceptPayeeship,
+  createCreateFeed,
+  createFundFeedRewardPool,
+  createSetPayees,
+  createTransferPayeeship,
+  createTransmit,
+  createUpdateFeed,
+  createWithdrawFeedRewardPool,
+} from "injectivejs/injective/ocr/v1beta1/tx.rpc.func";
+```
+
+#### Oracle Messages
+
+```js
+import {
+  createRelayBandRates,
+  createRelayCoinbaseMessages,
+  createRelayPriceFeedPrice,
+  createRelayProviderPrices,
+  createRelayPythPrices,
+  createRelayStorkMessage,
+  createRequestBandIBCRates,
+} from "injectivejs/injective/oracle/v1beta1/tx.rpc.func";
+```
+
+#### Peggy Messages
+
+```js
+import {
+  createBlacklistEthereumAddresses,
+  createCancelSendToEth,
+  createConfirmBatch,
+  createDepositClaim,
+  createERC20DeployedClaim,
+  createRequestBatch,
+  createRevokeEthereumBlacklist,
+  createSendToEth,
+  createSetOrchestratorAddresses,
+  createSubmitBadSignatureEvidence,
+  createValsetConfirm,
+  createValsetUpdateClaim,
+  createWithdrawClaim,
+} from "injectivejs/injective/peggy/v1/msgs.rpc.func";
+```
+
+#### CosmWasm Messages
+
+```js
+import {
+  createExecuteContract,
+  createClearAdmin,
+  createInstantiateContract,
+  createInstantiateContract2,
+  createMigrateContract,
+  createPinCodes,
+  createRemoveCodeUploadParamsAddresses,
+  createStoreAndInstantiateContract,
+  createStoreCode,
+  createSudoContract,
+  createUnpinCodes,
+  createUpdateAdmin,
+  createUpdateContractLabel,
+  createUpdateInstantiateConfig,
+  createAddCodeUploadParamsAddresses,
+  createStoreAndMigrateContract,
+} from "injectivejs/cosmwasm/wasm/v1/tx.rpc.func";
+```
+
+#### IBC Messages
+
+```js
+import { createTransfer } from "injectivejs/ibc/applications/transfer/v1/tx.rpc.func";
+```
+
+#### Cosmos Messages
+
+```js
+import {
+  createFundCommunityPool,
+  createCommunityPoolSpend,
+  createDepositValidatorRewardsPool,
+} from "injectivejs/cosmos/distribution/v1beta1/tx.rpc.func";
+
+import {
+  createSend,
+  createMultiSend,
+} from "injectivejs/cosmos/bank/v1beta1/tx.rpc.func";
+
+import {
+  createDelegate,
+  createUndelegate,
+  createCancelUnbondingDelegation,
+  createCreateValidator,
+} from "injectivejs/cosmos/staking/v1beta1/tx.rpc.func";
+
+import {
+  createDeposit,
+  createSubmitProposal,
+  createVote,
+  createVoteWeighted,
+} from "injectivejs/cosmos/gov/v1beta1/tx.rpc.func";
+```
+
+## Connecting with Wallets and Signing Messages
+
+⚡️ For web interfaces, we recommend using [interchain-kit](https://github.com/cosmology-tech/interchain-kit/). Continue below to see how to manually construct signers and clients.
+
+Here are the docs on [creating signers](https://github.com/cosmology-tech/interchain-kit/blob/main/packages/core/README.md) in interchain-kit that can be used with Keplr and other wallets.
+
+### Initializing the Stargate Client
+
+Use `getSigningInjectiveClient` to get your `SigningStargateClient`, with the proto/amino messages full-loaded. No need to manually add amino types, just require and initialize the client:
+
+```js
+import { InjSigningClient } from "@interchainjs/injective/signing-client";
+
+signingClient = await InjSigningClient.connectWithSigner(
+  await getRpcEndpoint(),
+  new AminoGenericOfflineSigner(aminoOfflineSigner)
+);
+```
+
+### Creating Signers
+
+To broadcast messages, you can create signers with a variety of options:
+
+- [interchain-kit](https://github.com/cosmology-tech/interchain-kit/) (recommended)
+- [keplr](https://docs.keplr.app/api/cosmjs.html)
+- [cosmjs](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9)
+
+### Broadcasting Messages
+
+When you have your `signing client`, you can broadcast messages:
+
+```js
+const msg = {
+  typeUrl: MsgSend.typeUrl,
+  value: MsgSend.fromPartial({
+    amount: [
+      {
+        denom: "inj",
+        amount: "1000",
+      },
+    ],
+    toAddress: address,
+    fromAddress: address,
+  }),
+};
+
+const fee: StdFee = {
+  amount: [
+    {
+      denom: "inj",
+      amount: "864",
+    },
+  ],
+  gas: "86364",
+};
+const response = await stargateClient.signAndBroadcast(address, [msg], fee);
+```
+
+## Advanced Usage
+
+If you want to manually construct a stargate client
+
+```js
+import {
+    cosmosAminoConverters,
+    cosmosProtoRegistry,
+    cosmwasmAminoConverters,
+    cosmwasmProtoRegistry,
+    ibcProtoRegistry,
+    ibcAminoConverters,
+    injectiveAminoConverters,
+    injectiveProtoRegistry
+} from 'injectivejs';
+
+const signer: OfflineSigner = /* create your signer (see above)  */
+const rpcEndpoint = 'https://rpc.cosmos.directory/injective'; // or another URL
+
+const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
+    ...cosmosProtoRegistry,
+    ...cosmwasmProtoRegistry,
+    ...ibcProtoRegistry,
+    ...injectiveProtoRegistry
+];
+
+const aminoConverters = {
+    ...cosmosAminoConverters,
+    ...cosmwasmAminoConverters,
+    ...ibcAminoConverters,
+    ...injectiveAminoConverters
+};
+
+const registry = new Registry(protoRegistry);
+const aminoTypes = new AminoTypes(aminoConverters);
+
+const signingClient = await InjSigningClient.connectWithSigner(rpcEndpoint, signer);
+
+signingClient.addEncoders(registry);
+signingClient.addConverters(aminoTypes);
+```
+
+## Developing
+
+When first cloning the repo:
+
+```shell
+yarn
+yarn build:dev
+```
+
+### Codegen
+
+Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/inj.telescope.json` and configure the settings for bundling your SDK and contracts into `injectivejs`:
+
+```shell
+yarn codegen
+```
+
+### Publishing
+
+Build the types and then publish:
+
+```shell
+yarn build
+yarn publish
+```
+
+## Credits
+
+🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.tech/validator)
+
+Code built with the help of these related projects:
+
+- [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) for generated CosmWasm contract Typescript classes
+- [@cosmology/telescope](https://github.com/cosmology-tech/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
 
 ## License