injectivejs 1.6.3 → 1.6.5

package/README.md

@@ -22,29 +22,41 @@ npm install injectivejs
 ## Table of contents
 
 - [InjectiveJS](#injectivejs)
-  - [Install](#install)
-  - [Table of contents](#table-of-contents)
+- [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)
+    - [Auction](#auction)
+    - [Exchange](#exchange)
+    - [Insurance](#insurance)
+    - [OCR](#ocr)
+    - [Oracle](#oracle)
+    - [Peggy](#peggy)
+    - [CosmWasm](#cosmwasm)
+    - [IBC](#ibc)
+    - [Cosmos](#cosmos)
+  - [Composing Messages](#composing-messages)
+    - [Auction Messages](#auction-messages)
+    - [Exchange Messages](#exchange-messages)
+    - [Insurance Messages](#insurance-messages)
+    - [OCR Messages](#ocr-messages)
+    - [Oracle Messages](#oracle-messages)
+    - [Peggy Messages](#peggy-messages)
+    - [CosmWasm Messages](#cosmwasm-messages)
+    - [IBC Messages](#ibc-messages)
+    - [Cosmos Messages](#cosmos-messages)
+- [Connecting with Wallets and Signing Messages](#connecting-with-wallets-and-signing-messages)
+  - [Initializing the Stargate Client](#initializing-the-stargate-client)
   - [Creating Signers](#creating-signers)
   - [Broadcasting Messages](#broadcasting-messages)
+- [All In One Example](#all-in-one-example)
 - [Advanced Usage](#advanced-usage)
 - [Developing](#developing)
+  - [Codegen](#codegen)
+  - [Publishing](#publishing)
 - [Credits](#credits)
+- [License](#license)
 
 ## Usage
 
@@ -77,6 +89,10 @@ const exchangeBalance = await getExchangeBalances({});
 
 For tx messages, there're helper functions to sign and broadcast messages:
 
+For more detailed usage on how to use these functions, please see the starship tests in the [networks/injective repo](https://github.com/cosmology-tech/interchainjs/tree/main/networks/injective/starship/__tests__)
+
+There're also react and vue hooks for helper functions. Please see [injective-react](https://github.com/cosmology-tech/interchainjs/tree/main/libs/injective-react) and [injective-vue](https://github.com/cosmology-tech/interchainjs/tree/main/libs/injective-vue) repos for more information.
+
 ```js
 import {
   createDeposit,
@@ -85,13 +101,13 @@ import {
 } from "injectivejs/injective/exchange/v1beta1/tx.rpc.func";
 ```
 
-#### Auction Messages
+#### Auction
 
 ```js
 import { createBid } from "injectivejs/injective/auction/v1beta1/tx.rpc.func";
 ```
 
-#### Exchange Messages
+#### Exchange
 
 ```js
 import {
@@ -133,7 +149,7 @@ import {
 } from "injectivejs/injective/exchange/v1beta1/tx.rpc.func";
 ```
 
-#### Insurance Messages
+#### Insurance
 
 ```js
 import {
@@ -143,7 +159,7 @@ import {
 } from "injectivejs/injective/insurance/v1beta1/tx.rpc.func";
 ```
 
-#### OCR Messages
+#### OCR
 
 ```js
 import {
@@ -158,7 +174,7 @@ import {
 } from "injectivejs/injective/ocr/v1beta1/tx.rpc.func";
 ```
 
-#### Oracle Messages
+#### Oracle
 
 ```js
 import {
@@ -172,7 +188,7 @@ import {
 } from "injectivejs/injective/oracle/v1beta1/tx.rpc.func";
 ```
 
-#### Peggy Messages
+#### Peggy
 
 ```js
 import {
@@ -192,7 +208,7 @@ import {
 } from "injectivejs/injective/peggy/v1/msgs.rpc.func";
 ```
 
-#### CosmWasm Messages
+#### CosmWasm
 
 ```js
 import {
@@ -215,13 +231,13 @@ import {
 } from "injectivejs/cosmwasm/wasm/v1/tx.rpc.func";
 ```
 
-#### IBC Messages
+#### IBC
 
 ```js
 import { createTransfer } from "injectivejs/ibc/applications/transfer/v1/tx.rpc.func";
 ```
 
-#### Cosmos Messages
+#### Cosmos
 
 ```js
 import {
@@ -250,6 +266,183 @@ import {
 } from "injectivejs/cosmos/gov/v1beta1/tx.rpc.func";
 ```
 
+### Composing Messages
+
+Import the `injective` object from `injectivejs`.
+
+```js
+import { MessageComposer } from "injectivejs/injective/exchange/v1beta1/tx.registry";
+
+const { createSpotLimitOrder, createSpotMarketOrder, deposit } =
+  MessageComposer.withTypeUrl;
+```
+
+#### Auction Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/auction/v1beta1/tx.registry";
+
+const { bid } = MessageComposer.withTypeUrl;
+```
+
+#### Exchange Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/exchange/v1beta1/tx.registry";
+
+const {
+  adminUpdateBinaryOptionsMarket,
+  batchCancelBinaryOptionsOrders,
+  batchCancelDerivativeOrders,
+  batchCancelSpotOrders,
+  batchCreateDerivativeLimitOrders,
+  batchCreateSpotLimitOrders,
+  batchUpdateOrders,
+  cancelBinaryOptionsOrder,
+  cancelDerivativeOrder,
+  cancelSpotOrder,
+  createBinaryOptionsLimitOrder,
+  createBinaryOptionsMarketOrder,
+  createDerivativeLimitOrder,
+  createDerivativeMarketOrder,
+  createSpotLimitOrder,
+  createSpotMarketOrder,
+  deposit,
+  exec,
+  externalTransfer,
+  increasePositionMargin,
+  instantBinaryOptionsMarketLaunch,
+  instantExpiryFuturesMarketLaunch,
+  instantPerpetualMarketLaunch,
+  instantSpotMarketLaunch,
+  liquidatePosition,
+  rewardsOptOut,
+  subaccountTransfer,
+  withdraw,
+} = MessageComposer.withTypeUrl;
+```
+
+#### Insurance Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/insurance/v1beta1/tx.registry";
+
+const { createInsuranceFund, requestRedemption, underwrite } =
+  MessageComposer.withTypeUrl;
+```
+
+#### OCR Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/ocr/v1beta1/tx.registry";
+
+const {
+  acceptPayeeship,
+  createFeed,
+  fundFeedRewardPool,
+  setPayees,
+  transferPayeeship,
+  transmit,
+  updateFeed,
+  withdrawFeedRewardPool,
+} = MessageComposer.withTypeUrl;
+```
+
+#### Oracle Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/oracle/v1beta1/tx.registry";
+
+const {
+  relayBandRates,
+  relayCoinbaseMessages,
+  relayPriceFeedPrice,
+  relayProviderPrices,
+  requestBandIBCRates,
+} = MessageComposer.withTypeUrl;
+```
+
+#### Peggy Messages
+
+```js
+import { MessageComposer } from "injectivejs/injective/peggy/v1/tx.registry";
+
+const {
+  cancelSendToEth,
+  confirmBatch,
+  depositClaim,
+  eRC20DeployedClaim,
+  requestBatch,
+  sendToEth,
+  setOrchestratorAddresses,
+  submitBadSignatureEvidence,
+  valsetConfirm,
+  valsetUpdateClaim,
+  withdrawClaim,
+} = MessageComposer.withTypeUrl;
+```
+
+#### CosmWasm Messages
+
+```js
+import { MessageComposer } from "injectivejs/cosmwasm/wasm/v1/tx.registry";
+
+const {
+  clearAdmin,
+  executeContract,
+  instantiateContract,
+  migrateContract,
+  storeCode,
+  updateAdmin,
+} = MessageComposer.withTypeUrl;
+```
+
+#### IBC Messages
+
+```js
+import { MessageComposer } from "injectivejs/ibc/applications/transfer/v1/tx.registry";
+
+const { transfer } = MessageComposer.withTypeUrl;
+```
+
+#### Cosmos Messages
+
+```js
+import { MessageComposer } from "injectivejs/cosmos/distribution/v1beta1/tx.registry";
+
+const {
+  fundCommunityPool,
+  setWithdrawAddress,
+  withdrawDelegatorReward,
+  withdrawValidatorCommission,
+} = MessageComposer.fromPartial;
+```
+
+```js
+import { MessageComposer } from "injectivejs/cosmos/bank/v1beta1/tx.registry";
+
+const { multiSend, send } = MessageComposer.fromPartial;
+```
+
+```js
+import { MessageComposer } from "injectivejs/cosmos/staking/v1beta1/tx.registry";
+
+const {
+  beginRedelegate,
+  createValidator,
+  delegate,
+  editValidator,
+  undelegate,
+} = MessageComposer.fromPartial;
+```
+
+```js
+import { MessageComposer } from "injectivejs/cosmos/gov/v1beta1/tx.registry";
+
+const { deposit, submitProposal, vote, voteWeighted } =
+  cosmos.gov.v1beta1.MessageComposer.fromPartial;
+```
+
 ## 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.
@@ -308,6 +501,19 @@ const fee: StdFee = {
 const response = await stargateClient.signAndBroadcast(address, [msg], fee);
 ```
 
+### All In One Example
+
+For a comprehensive example of how to use InjectiveJS to send messages, please see the example [here](https://github.com/cosmology-tech/create-cosmos-app/blob/main/examples/injective/components/SendMsg.tsx). This example demonstrates how to:
+
+- Initialize the client.
+- Create and sign messages.
+- Broadcast transactions.
+- Handle responses and errors.
+
+The example provides a complete walkthrough of setting up the client, creating a message for sending tokens, and broadcasting the transaction to the Injective blockchain.
+
+Follow the [instructions](https://github.com/cosmology-tech/create-cosmos-app/tree/main/examples/injective) in the example to set up your InjectiveJS client and start sending messages to the Injective blockchain.
+
 ## Advanced Usage
 
 If you want to manually construct a stargate client

package/binary.d.ts

@@ -1,5 +1,5 @@
 /**
-* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.0
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.3
 * DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
 * and run the transpile command or npm scripts command that is used to regenerate this bundle.
 */

package/binary.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
-* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.0
+* This file and any referenced files were automatically generated by @cosmology/telescope@1.11.3
 * DO NOT MODIFY BY HAND. Instead, download the latest proto files for your chain
 * and run the transpile command or npm scripts command that is used to regenerate this bundle.
 */

package/cosmos/authz/v1beta1/tx.registry.d.ts

@@ -0,0 +1,47 @@
+import { TelescopeGeneratedType } from "../../../types";
+import { MsgGrant, MsgExec, MsgRevoke } from "./tx";
+export declare const registry: ReadonlyArray<[string, TelescopeGeneratedType<any, any, any>]>;
+export declare const MessageComposer: {
+    encoded: {
+        grant(value: MsgGrant): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+        exec(value: MsgExec): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+        revoke(value: MsgRevoke): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+    };
+    withTypeUrl: {
+        grant(value: MsgGrant): {
+            typeUrl: string;
+            value: MsgGrant;
+        };
+        exec(value: MsgExec): {
+            typeUrl: string;
+            value: MsgExec;
+        };
+        revoke(value: MsgRevoke): {
+            typeUrl: string;
+            value: MsgRevoke;
+        };
+    };
+    fromPartial: {
+        grant(value: MsgGrant): {
+            typeUrl: string;
+            value: MsgGrant;
+        };
+        exec(value: MsgExec): {
+            typeUrl: string;
+            value: MsgExec;
+        };
+        revoke(value: MsgRevoke): {
+            typeUrl: string;
+            value: MsgRevoke;
+        };
+    };
+};

package/cosmos/authz/v1beta1/tx.registry.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageComposer = exports.registry = void 0;
+const tx_1 = require("./tx");
+exports.registry = [["/cosmos.authz.v1beta1.MsgGrant", tx_1.MsgGrant], ["/cosmos.authz.v1beta1.MsgExec", tx_1.MsgExec], ["/cosmos.authz.v1beta1.MsgRevoke", tx_1.MsgRevoke]];
+exports.MessageComposer = {
+    encoded: {
+        grant(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgGrant",
+                value: tx_1.MsgGrant.encode(value).finish()
+            };
+        },
+        exec(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgExec",
+                value: tx_1.MsgExec.encode(value).finish()
+            };
+        },
+        revoke(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgRevoke",
+                value: tx_1.MsgRevoke.encode(value).finish()
+            };
+        }
+    },
+    withTypeUrl: {
+        grant(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgGrant",
+                value
+            };
+        },
+        exec(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgExec",
+                value
+            };
+        },
+        revoke(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgRevoke",
+                value
+            };
+        }
+    },
+    fromPartial: {
+        grant(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgGrant",
+                value: tx_1.MsgGrant.fromPartial(value)
+            };
+        },
+        exec(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgExec",
+                value: tx_1.MsgExec.fromPartial(value)
+            };
+        },
+        revoke(value) {
+            return {
+                typeUrl: "/cosmos.authz.v1beta1.MsgRevoke",
+                value: tx_1.MsgRevoke.fromPartial(value)
+            };
+        }
+    }
+};

package/cosmos/bank/v1beta1/tx.registry.d.ts

@@ -0,0 +1,59 @@
+import { TelescopeGeneratedType } from "../../../types";
+import { MsgSend, MsgMultiSend, MsgUpdateParams, MsgSetSendEnabled } from "./tx";
+export declare const registry: ReadonlyArray<[string, TelescopeGeneratedType<any, any, any>]>;
+export declare const MessageComposer: {
+    encoded: {
+        send(value: MsgSend): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+        multiSend(value: MsgMultiSend): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+        updateParams(value: MsgUpdateParams): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+        setSendEnabled(value: MsgSetSendEnabled): {
+            typeUrl: string;
+            value: Uint8Array;
+        };
+    };
+    withTypeUrl: {
+        send(value: MsgSend): {
+            typeUrl: string;
+            value: MsgSend;
+        };
+        multiSend(value: MsgMultiSend): {
+            typeUrl: string;
+            value: MsgMultiSend;
+        };
+        updateParams(value: MsgUpdateParams): {
+            typeUrl: string;
+            value: MsgUpdateParams;
+        };
+        setSendEnabled(value: MsgSetSendEnabled): {
+            typeUrl: string;
+            value: MsgSetSendEnabled;
+        };
+    };
+    fromPartial: {
+        send(value: MsgSend): {
+            typeUrl: string;
+            value: MsgSend;
+        };
+        multiSend(value: MsgMultiSend): {
+            typeUrl: string;
+            value: MsgMultiSend;
+        };
+        updateParams(value: MsgUpdateParams): {
+            typeUrl: string;
+            value: MsgUpdateParams;
+        };
+        setSendEnabled(value: MsgSetSendEnabled): {
+            typeUrl: string;
+            value: MsgSetSendEnabled;
+        };
+    };
+};

package/cosmos/bank/v1beta1/tx.registry.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageComposer = exports.registry = void 0;
+const tx_1 = require("./tx");
+exports.registry = [["/cosmos.bank.v1beta1.MsgSend", tx_1.MsgSend], ["/cosmos.bank.v1beta1.MsgMultiSend", tx_1.MsgMultiSend], ["/cosmos.bank.v1beta1.MsgUpdateParams", tx_1.MsgUpdateParams], ["/cosmos.bank.v1beta1.MsgSetSendEnabled", tx_1.MsgSetSendEnabled]];
+exports.MessageComposer = {
+    encoded: {
+        send(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSend",
+                value: tx_1.MsgSend.encode(value).finish()
+            };
+        },
+        multiSend(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgMultiSend",
+                value: tx_1.MsgMultiSend.encode(value).finish()
+            };
+        },
+        updateParams(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgUpdateParams",
+                value: tx_1.MsgUpdateParams.encode(value).finish()
+            };
+        },
+        setSendEnabled(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSetSendEnabled",
+                value: tx_1.MsgSetSendEnabled.encode(value).finish()
+            };
+        }
+    },
+    withTypeUrl: {
+        send(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSend",
+                value
+            };
+        },
+        multiSend(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgMultiSend",
+                value
+            };
+        },
+        updateParams(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgUpdateParams",
+                value
+            };
+        },
+        setSendEnabled(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSetSendEnabled",
+                value
+            };
+        }
+    },
+    fromPartial: {
+        send(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSend",
+                value: tx_1.MsgSend.fromPartial(value)
+            };
+        },
+        multiSend(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgMultiSend",
+                value: tx_1.MsgMultiSend.fromPartial(value)
+            };
+        },
+        updateParams(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgUpdateParams",
+                value: tx_1.MsgUpdateParams.fromPartial(value)
+            };
+        },
+        setSendEnabled(value) {
+            return {
+                typeUrl: "/cosmos.bank.v1beta1.MsgSetSendEnabled",
+                value: tx_1.MsgSetSendEnabled.fromPartial(value)
+            };
+        }
+    }
+};