coreum-js 2.6.5 → 2.6.6

package/README.md

@@ -21,9 +21,10 @@ This is the recommended library for integrating a JavaScript/TypeScript app with
 
 1. [QuickStart](#md:quickstart)
 2. [Usage](#md:usage)
-3. [Query for balances](#md:query-balances)
-4. [Submit Transaction](#md:submit-transaction)
-5. [Event Subscription](#md:event-subscription)
+3. [Transaction Modules](#md:transaction-modules)
+4. [Query for balances](#md:query-balances)
+5. [Submit Transaction](#md:submit-transaction)
+6. [Event Subscription](#md:event-subscription)
 
 ## Quickstart
 
@@ -94,6 +95,28 @@ subscription.unsubscribe();
 const registry = Client.getRegistry();
 ```
 
+## Transaction Modules
+
+_coreum-js_ comes with out-of-the-box modules to create messages compatible with the Cosmos-SDK and Coreum Blockchain.
+
+- [Authz](./modules/Authz.html)
+  Authorization for accounts to perform actions on behalf of other accounts.
+- [Bank](./modules/Bank.html)
+  Token transfer functionalities.
+- [CosmWasm](./modules/CosmWasm.html)
+  Smart Contracts functionalities.
+- [Distribution](./modules/Distribution.html)
+  Fee distribution, and staking token provision distribution.
+- [Feegrant](./modules/Feegrant.html)
+  Grant fee allowances for executing transactions.
+- [FT](./modules/FT.html)
+  Token issuance and management functionalities.
+- [NFT](./modules/NFT.html)
+  Non-Fungible Tokens minting and management functionalities.
+- [Staking](./modules/Staking.html)
+  Proof-of-Stake layer for public blockchains.
+- [Vesting](./modules/Vesting.html)
+
 ## Query Balances
 
 ```js

package/dist/main/coreum/index.d.ts

@@ -16,6 +16,7 @@ export declare const coreumRegistry: ReadonlyArray<[string, GeneratedType]>;
  */
 export declare namespace FT {
     /** MsgMint message creator
+     * Mints new fungible tokens.
      *
      * @param object Represents the properties available for this MsgMint message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -40,6 +41,7 @@ export declare namespace FT {
         value: FTMsgMint;
     };
     /** MsgIssue message creator
+     * Defines a method to issue a new fungible token.
      *
      * @param object Represents the properties available for this MsgIssue message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -69,6 +71,7 @@ export declare namespace FT {
         value: FTMsgIssue;
     };
     /** MsgBurn message creator
+     * Burns the specified fungible tokens from senders balance if the sender has enough balance.
      *
      * @param object Represents the properties available for this MsgBurn message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -93,6 +96,7 @@ export declare namespace FT {
         value: FTMsgBurn;
     };
     /** MsgFreeze message creator
+     * Freezes a part of the fungible tokens in an account, only if the freezable feature is enabled on that token.
      *
      * @param object Represents the properties available for this MsgIssue message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -119,6 +123,7 @@ export declare namespace FT {
         value: FTMsgFreeze;
     };
     /** MsgGloballyFreeze message creator
+     * Freezes fungible token so no operations are allowed with it before unfrozen. This operation is idempotent so global freeze of already frozen token does nothing.
      *
      * @param object Represents the properties available for this MsgGloballyFreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -134,6 +139,7 @@ export declare namespace FT {
         value: FTMsgGloballyFreeze;
     };
     /** MsgGloballyUnfreeze message creator
+     * Unfreezes fungible token and unblocks basic operations on it. This operation is idempotent so global unfreezing of non-frozen token does nothing.
      *
      * @param object Represents the properties available for this MsgGloballyUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -149,6 +155,7 @@ export declare namespace FT {
         value: FTMsgGloballyUnfreeze;
     };
     /** MsgUnfreeze message creator
+     * Unfreezes a part of the frozen fungible tokens in an account, only if there are such frozen tokens on that account.
      *
      * @param object Represents the properties available for this MsgUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -175,6 +182,7 @@ export declare namespace FT {
         value: FTMsgUnfreeze;
     };
     /** MsgSetWhitelistedLimit message creator
+     * Sets the limit of how many tokens a specific account may hold.
      *
      * @param object Represents the properties available for this MsgSetWhitelistedLimit message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -206,6 +214,7 @@ export declare namespace FT {
  */
 export declare namespace NFT {
     /** MsgMint message creator
+     * Mints new non-fungible token in the class.
      *
      * @param object Represents the properties available for this MsgMint message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -238,6 +247,7 @@ export declare namespace NFT {
         value: NFTMsgMint;
     };
     /** MsgAddToWhitelist message creator
+     * Sets the account as whitelisted to hold the NFT
      *
      * @param object Represents the properties available for this MsgAddToWhitelist message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -257,6 +267,7 @@ export declare namespace NFT {
         value: NFTMsgAddToWhitelist;
     };
     /** MsgRemoveFromWhitelist message creator
+     * Removes an account from whitelisted list of the NFT
      *
      * @param object Represents the properties available for this MsgRemoveFromWhitelist message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -276,6 +287,7 @@ export declare namespace NFT {
         value: NFTMsgRemoveFromWhitelist;
     };
     /** MsgBurn message creator
+     * Burns the existing non-fungible token in the class.
      *
      * @param object Represents the properties available for this MsgBurn message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -293,6 +305,7 @@ export declare namespace NFT {
         value: NFTMsgBurn;
     };
     /** MsgFreeze message creator
+     * Freezes an NFT
      *
      * @param object Represents the properties available for this MsgFreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -310,6 +323,7 @@ export declare namespace NFT {
         value: NFTMsgFreeze;
     };
     /** MsgUnfreeze message creator
+     * Removes the freeze effect already put on an NFT
      *
      * @param object Represents the properties available for this MsgUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -327,6 +341,7 @@ export declare namespace NFT {
         value: NFTMsgUnfreeze;
     };
     /** MsgIssueClass message creator
+     * Creates new non-fungible token class.
      *
      * @param object Represents the properties available for this MsgIssueClass message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -365,6 +380,7 @@ export declare namespace NFT {
         value: NFTMsgIssueClass;
     };
     /** MsgSend message creator
+     * Represents a message to send a nft from one account to another account.
      *
      * @param object Represents the properties available for this MsgSend message.
      * @returns A Msg object with the typeUrl and value object for the proper message

package/dist/main/coreum/index.js

@@ -20,6 +20,7 @@ exports.coreumRegistry = [
 var FT;
 (function (FT) {
     /** MsgMint message creator
+     * Mints new fungible tokens.
      *
      * @param object Represents the properties available for this MsgMint message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -31,6 +32,7 @@ var FT;
         };
     };
     /** MsgIssue message creator
+     * Defines a method to issue a new fungible token.
      *
      * @param object Represents the properties available for this MsgIssue message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -42,6 +44,7 @@ var FT;
         };
     };
     /** MsgBurn message creator
+     * Burns the specified fungible tokens from senders balance if the sender has enough balance.
      *
      * @param object Represents the properties available for this MsgBurn message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -53,6 +56,7 @@ var FT;
         };
     };
     /** MsgFreeze message creator
+     * Freezes a part of the fungible tokens in an account, only if the freezable feature is enabled on that token.
      *
      * @param object Represents the properties available for this MsgIssue message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -64,6 +68,7 @@ var FT;
         };
     };
     /** MsgGloballyFreeze message creator
+     * Freezes fungible token so no operations are allowed with it before unfrozen. This operation is idempotent so global freeze of already frozen token does nothing.
      *
      * @param object Represents the properties available for this MsgGloballyFreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -75,6 +80,7 @@ var FT;
         };
     };
     /** MsgGloballyUnfreeze message creator
+     * Unfreezes fungible token and unblocks basic operations on it. This operation is idempotent so global unfreezing of non-frozen token does nothing.
      *
      * @param object Represents the properties available for this MsgGloballyUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -86,6 +92,7 @@ var FT;
         };
     };
     /** MsgUnfreeze message creator
+     * Unfreezes a part of the frozen fungible tokens in an account, only if there are such frozen tokens on that account.
      *
      * @param object Represents the properties available for this MsgUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -97,6 +104,7 @@ var FT;
         };
     };
     /** MsgSetWhitelistedLimit message creator
+     * Sets the limit of how many tokens a specific account may hold.
      *
      * @param object Represents the properties available for this MsgSetWhitelistedLimit message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -114,6 +122,7 @@ var FT;
 var NFT;
 (function (NFT) {
     /** MsgMint message creator
+     * Mints new non-fungible token in the class.
      *
      * @param object Represents the properties available for this MsgMint message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -125,6 +134,7 @@ var NFT;
         };
     };
     /** MsgAddToWhitelist message creator
+     * Sets the account as whitelisted to hold the NFT
      *
      * @param object Represents the properties available for this MsgAddToWhitelist message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -136,6 +146,7 @@ var NFT;
         };
     };
     /** MsgRemoveFromWhitelist message creator
+     * Removes an account from whitelisted list of the NFT
      *
      * @param object Represents the properties available for this MsgRemoveFromWhitelist message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -147,6 +158,7 @@ var NFT;
         };
     };
     /** MsgBurn message creator
+     * Burns the existing non-fungible token in the class.
      *
      * @param object Represents the properties available for this MsgBurn message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -158,6 +170,7 @@ var NFT;
         };
     };
     /** MsgFreeze message creator
+     * Freezes an NFT
      *
      * @param object Represents the properties available for this MsgFreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -169,6 +182,7 @@ var NFT;
         };
     };
     /** MsgUnfreeze message creator
+     * Removes the freeze effect already put on an NFT
      *
      * @param object Represents the properties available for this MsgUnfreeze message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -180,6 +194,7 @@ var NFT;
         };
     };
     /** MsgIssueClass message creator
+     * Creates new non-fungible token class.
      *
      * @param object Represents the properties available for this MsgIssueClass message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -191,6 +206,7 @@ var NFT;
         };
     };
     /** MsgSend message creator
+     * Represents a message to send a nft from one account to another account.
      *
      * @param object Represents the properties available for this MsgSend message.
      * @returns A Msg object with the typeUrl and value object for the proper message
@@ -202,4 +218,4 @@ var NFT;
         };
     };
 })(NFT = exports.NFT || (exports.NFT = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29yZXVtL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLG1DQUE0RDtBQUM1RCwrQkFBd0M7QUFDeEMseUNBQXlEO0FBQ3pELDBDQVUyQjtBQUMzQix5Q0FTMEI7QUFRMUI7O0dBRUc7QUFDVSxRQUFBLGNBQWMsR0FBMkM7SUFDcEUsR0FBRyx1QkFBZTtJQUNsQixHQUFHLHdCQUFnQjtJQUNuQixHQUFHLHFCQUFlO0NBQ25CLENBQUM7QUFFRjs7R0FFRztBQUNILElBQWlCLEVBQUUsQ0FnSGxCO0FBaEhELFdBQWlCLEVBQUU7SUFDakI7Ozs7T0FJRztJQUNVLE9BQUksR0FBRyxVQUNsQixNQUFTO1FBRVQsT0FBTztZQUNMLE9BQU8sRUFBRSw2QkFBNkI7WUFDdEMsS0FBSyxFQUFFLFlBQVMsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3JDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7OztPQUlHO0lBQ1UsUUFBSyxHQUFHLFVBQ25CLE1BQVM7UUFFVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLDhCQUE4QjtZQUN2QyxLQUFLLEVBQUUsYUFBVSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDdEMsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSxPQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsNkJBQTZCO1lBQ3RDLEtBQUssRUFBRSxZQUFTLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUNyQyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7T0FJRztJQUNVLFNBQU0sR0FBRyxVQUNwQixNQUFTO1FBRVQsT0FBTztZQUNMLE9BQU8sRUFBRSwrQkFBK0I7WUFDeEMsS0FBSyxFQUFFLGNBQVcsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3ZDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7OztPQUlHO0lBQ1UsaUJBQWMsR0FBRyxVQUU1QixNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSx1Q0FBdUM7WUFDaEQsS0FBSyxFQUFFLHNCQUFtQixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDL0MsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSxtQkFBZ0IsR0FBRyxVQUU5QixNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSx5Q0FBeUM7WUFDbEQsS0FBSyxFQUFFLHdCQUFxQixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDakQsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSxXQUFRLEdBQUcsVUFFdEIsTUFBUztRQUNULE9BQU87WUFDTCxPQUFPLEVBQUUsaUNBQWlDO1lBQzFDLEtBQUssRUFBRSxnQkFBYSxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDekMsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSxzQkFBbUIsR0FBRyxVQUVqQyxNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSw0Q0FBNEM7WUFDckQsS0FBSyxFQUFFLDJCQUF3QixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDcEQsQ0FBQztJQUNKLENBQUMsQ0FBQztBQUNKLENBQUMsRUFoSGdCLEVBQUUsR0FBRixVQUFFLEtBQUYsVUFBRSxRQWdIbEI7QUFFRDs7R0FFRztBQUNILElBQWlCLEdBQUcsQ0FnSG5CO0FBaEhELFdBQWlCLEdBQUc7SUFDbEI7Ozs7T0FJRztJQUNVLFFBQUksR0FBRyxVQUNsQixNQUFTO1FBRVQsT0FBTztZQUNMLE9BQU8sRUFBRSw4QkFBOEI7WUFDdkMsS0FBSyxFQUFFLFlBQVUsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3RDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7OztPQUlHO0lBQ1Usa0JBQWMsR0FBRyxVQUU1QixNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSx3Q0FBd0M7WUFDakQsS0FBSyxFQUFFLHNCQUFvQixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDaEQsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSx1QkFBbUIsR0FBRyxVQUVqQyxNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSw2Q0FBNkM7WUFDdEQsS0FBSyxFQUFFLDJCQUF5QixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDckQsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7O09BSUc7SUFDVSxRQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsOEJBQThCO1lBQ3ZDLEtBQUssRUFBRSxZQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN0QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7T0FJRztJQUNVLFVBQU0sR0FBRyxVQUVwQixNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSxnQ0FBZ0M7WUFDekMsS0FBSyxFQUFFLGNBQVksQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3hDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7OztPQUlHO0lBQ1UsWUFBUSxHQUFHLFVBRXRCLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLGtDQUFrQztZQUMzQyxLQUFLLEVBQUUsZ0JBQWMsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQzFDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7OztPQUlHO0lBQ1UsY0FBVSxHQUFHLFVBRXhCLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLG9DQUFvQztZQUM3QyxLQUFLLEVBQUUsa0JBQWdCLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUM1QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7T0FJRztJQUNVLFFBQUksR0FBRyxVQUNsQixNQUFTO1FBRVQsT0FBTztZQUNMLE9BQU8sRUFBRSw2QkFBNkI7WUFDdEMsS0FBSyxFQUFFLFlBQVUsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3RDLENBQUM7SUFDSixDQUFDLENBQUM7QUFDSixDQUFDLEVBaEhnQixHQUFHLEdBQUgsV0FBRyxLQUFILFdBQUcsUUFnSG5CIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29yZXVtL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLG1DQUE0RDtBQUM1RCwrQkFBd0M7QUFDeEMseUNBQXlEO0FBQ3pELDBDQVUyQjtBQUMzQix5Q0FTMEI7QUFRMUI7O0dBRUc7QUFDVSxRQUFBLGNBQWMsR0FBMkM7SUFDcEUsR0FBRyx1QkFBZTtJQUNsQixHQUFHLHdCQUFnQjtJQUNuQixHQUFHLHFCQUFlO0NBQ25CLENBQUM7QUFFRjs7R0FFRztBQUNILElBQWlCLEVBQUUsQ0F3SGxCO0FBeEhELFdBQWlCLEVBQUU7SUFDakI7Ozs7O09BS0c7SUFDVSxPQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsNkJBQTZCO1lBQ3RDLEtBQUssRUFBRSxZQUFTLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUNyQyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxRQUFLLEdBQUcsVUFDbkIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsOEJBQThCO1lBQ3ZDLEtBQUssRUFBRSxhQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN0QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxPQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsNkJBQTZCO1lBQ3RDLEtBQUssRUFBRSxZQUFTLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUNyQyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxTQUFNLEdBQUcsVUFDcEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsK0JBQStCO1lBQ3hDLEtBQUssRUFBRSxjQUFXLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN2QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxpQkFBYyxHQUFHLFVBRTVCLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLHVDQUF1QztZQUNoRCxLQUFLLEVBQUUsc0JBQW1CLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUMvQyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxtQkFBZ0IsR0FBRyxVQUU5QixNQUFTO1FBQ1QsT0FBTztZQUNMLE9BQU8sRUFBRSx5Q0FBeUM7WUFDbEQsS0FBSyxFQUFFLHdCQUFxQixDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDakQsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7OztPQUtHO0lBQ1UsV0FBUSxHQUFHLFVBRXRCLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLGlDQUFpQztZQUMxQyxLQUFLLEVBQUUsZ0JBQWEsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3pDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7Ozs7T0FLRztJQUNVLHNCQUFtQixHQUFHLFVBRWpDLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLDRDQUE0QztZQUNyRCxLQUFLLEVBQUUsMkJBQXdCLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUNwRCxDQUFDO0lBQ0osQ0FBQyxDQUFDO0FBQ0osQ0FBQyxFQXhIZ0IsRUFBRSxHQUFGLFVBQUUsS0FBRixVQUFFLFFBd0hsQjtBQUVEOztHQUVHO0FBQ0gsSUFBaUIsR0FBRyxDQXdIbkI7QUF4SEQsV0FBaUIsR0FBRztJQUNsQjs7Ozs7T0FLRztJQUNVLFFBQUksR0FBRyxVQUNsQixNQUFTO1FBRVQsT0FBTztZQUNMLE9BQU8sRUFBRSw4QkFBOEI7WUFDdkMsS0FBSyxFQUFFLFlBQVUsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ3RDLENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7Ozs7T0FLRztJQUNVLGtCQUFjLEdBQUcsVUFFNUIsTUFBUztRQUNULE9BQU87WUFDTCxPQUFPLEVBQUUsd0NBQXdDO1lBQ2pELEtBQUssRUFBRSxzQkFBb0IsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDO1NBQ2hELENBQUM7SUFDSixDQUFDLENBQUM7SUFFRjs7Ozs7T0FLRztJQUNVLHVCQUFtQixHQUFHLFVBRWpDLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLDZDQUE2QztZQUN0RCxLQUFLLEVBQUUsMkJBQXlCLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUNyRCxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxRQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsOEJBQThCO1lBQ3ZDLEtBQUssRUFBRSxZQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN0QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxVQUFNLEdBQUcsVUFFcEIsTUFBUztRQUNULE9BQU87WUFDTCxPQUFPLEVBQUUsZ0NBQWdDO1lBQ3pDLEtBQUssRUFBRSxjQUFZLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN4QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxZQUFRLEdBQUcsVUFFdEIsTUFBUztRQUNULE9BQU87WUFDTCxPQUFPLEVBQUUsa0NBQWtDO1lBQzNDLEtBQUssRUFBRSxnQkFBYyxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUM7U0FDMUMsQ0FBQztJQUNKLENBQUMsQ0FBQztJQUVGOzs7OztPQUtHO0lBQ1UsY0FBVSxHQUFHLFVBRXhCLE1BQVM7UUFDVCxPQUFPO1lBQ0wsT0FBTyxFQUFFLG9DQUFvQztZQUM3QyxLQUFLLEVBQUUsa0JBQWdCLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUM1QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0lBRUY7Ozs7O09BS0c7SUFDVSxRQUFJLEdBQUcsVUFDbEIsTUFBUztRQUVULE9BQU87WUFDTCxPQUFPLEVBQUUsNkJBQTZCO1lBQ3RDLEtBQUssRUFBRSxZQUFVLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQztTQUN0QyxDQUFDO0lBQ0osQ0FBQyxDQUFDO0FBQ0osQ0FBQyxFQXhIZ0IsR0FBRyxHQUFILFdBQUcsS0FBSCxXQUFHLFFBd0huQiJ9

package/dist/main/cosmos/index.d.ts

@@ -9,6 +9,12 @@ import { MsgExec, MsgGrant, MsgRevoke } from "./authz/v1beta1/tx";
  * Module to generate the Messages related to the Authz module of the Blockchain
  */
 export declare namespace Authz {
+    /** MsgGrant message creator
+     * Grants the provided authorization to the grantee on the granter's account with the provided expiration time. If there is already a grant for the given (granter, grantee, Authorization) triple, then the grant will be overwritten.
+     *
+     * @param object Represents the properties available for this MsgGrant message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Grant: <I extends {
         granter?: string;
         grantee?: string;
@@ -42,6 +48,12 @@ export declare namespace Authz {
         typeUrl: string;
         value: MsgGrant;
     };
+    /** MsgExec message creator
+     * Attempts to execute the provided messages using authorizations granted to the grantee. Each message should have only one signer corresponding to the granter of the authorization.
+     *
+     * @param object Represents the properties available for this MsgExec message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Exec: <I extends {
         grantee?: string;
         msgs?: {
@@ -67,6 +79,12 @@ export declare namespace Authz {
         typeUrl: string;
         value: MsgExec;
     };
+    /** MsgRevoke message creator
+     * Revokes any authorization corresponding to the provided method name on the granter's account that has been granted to the grantee.
+     *
+     * @param object Represents the properties available for this MsgRevoke message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Revoke: <I extends {
         granter?: string;
         grantee?: string;
@@ -84,6 +102,12 @@ export declare namespace Authz {
  * Module to generate the Messages related to the Staking module of the Blockchain
  */
 export declare namespace Staking {
+    /** MsgBeginRedelegate message creator
+     * Defines a method for performing a redelegation of coins from a delegator and source validator to a destination validator.
+     *
+     * @param object Represents the properties available for this MsgBeginRedelegate message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const BeginRedelegate: <I extends {
         delegatorAddress?: string;
         validatorSrcAddress?: string;
@@ -107,6 +131,11 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgBeginRedelegate;
     };
+    /** MsgCancelUnbondingDelegation message creator
+     *
+     * @param object Represents the properties available for this MsgCancelUnbondingDelegation message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const CancelUnbondingDelegation: <I extends {
         delegatorAddress?: string;
         validatorAddress?: string;
@@ -130,6 +159,12 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgCancelUnbondingDelegation;
     };
+    /** MsgCreateValidator message creator
+     * Defines a method for creating a new validator.
+     *
+     * @param object Represents the properties available for this MsgCreateValidator message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const CreateValidator: <I extends {
         description?: {
             moniker?: string;
@@ -198,6 +233,12 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgCreateValidator;
     };
+    /** MsgDelegate message creator
+     * Defines a method for performing a delegation of coins from a delegator to a validator.
+     *
+     * @param object Represents the properties available for this MsgDelegate message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Delegate: <I extends {
         delegatorAddress?: string;
         validatorAddress?: string;
@@ -219,6 +260,12 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgDelegate;
     };
+    /** MsgEditValidator message creator
+     * Defines a method for editing an existing validator.
+     *
+     * @param object Represents the properties available for this MsgEditValidator message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const EditValidator: <I extends {
         description?: {
             moniker?: string;
@@ -251,6 +298,12 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgEditValidator;
     };
+    /** MsgUndelegate message creator
+     * Defines a method for performing an undelegation from a delegate and a validator.
+     *
+     * @param object Represents the properties available for this MsgUndelegate message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Undelegate: <I extends {
         delegatorAddress?: string;
         validatorAddress?: string;
@@ -272,6 +325,11 @@ export declare namespace Staking {
         typeUrl: string;
         value: MsgUndelegate;
     };
+    /** MsgUpdateParams message creator
+     *
+     * @param object Represents the properties available for this MsgUpdateParams message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const UpdateParams: <I extends {
         authority?: string;
         params?: {
@@ -320,6 +378,12 @@ export declare namespace Staking {
  * Module to generate the Messages related to the Governance module of the Blockchain
  */
 export declare namespace Governance {
+    /** MsgDeposit message creator
+     * Defines a method to add deposit on a specific proposal.
+     *
+     * @param object Represents the properties available for this MsgDeposit message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Deposit: <I extends {
         proposalId?: number;
         depositor?: string;
@@ -347,6 +411,12 @@ export declare namespace Governance {
         typeUrl: string;
         value: MsgDeposit;
     };
+    /** MsgSubmitProposal message creator
+     * Defines a method to create new proposal given a content.
+     *
+     * @param object Represents the properties available for this MsgSubmitProposal message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const SubmitProposal: <I extends {
         content?: {
             typeUrl?: string;
@@ -383,6 +453,12 @@ export declare namespace Governance {
         typeUrl: string;
         value: MsgSubmitProposal;
     };
+    /** MsgVote message creator
+     * Defines a method to add a vote on a specific proposal.
+     *
+     * @param object Represents the properties available for this MsgVote message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Vote: <I extends {
         proposalId?: number;
         voter?: string;
@@ -395,6 +471,12 @@ export declare namespace Governance {
         typeUrl: string;
         value: MsgVote;
     };
+    /** MsgVoteWeighted message creator
+     * Defines a method to add a weighted vote on a specific proposal.
+     *
+     * @param object Represents the properties available for this MsgVoteWeighted message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const VoteWeighted: <I extends {
         proposalId?: number;
         voter?: string;
@@ -427,6 +509,12 @@ export declare namespace Governance {
  * Module to generate the Messages related to the Feegrant module of the Blockchain
  */
 export declare namespace Feegrant {
+    /** MsgGrantAllowance message creator
+     * Grants fee allowance to the grantee on the granter's account with the provided expiration time.
+     *
+     * @param object Represents the properties available for this MsgGrantAllowance message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const GrantAllowance: <I extends {
         granter?: string;
         grantee?: string;
@@ -448,6 +536,12 @@ export declare namespace Feegrant {
         typeUrl: string;
         value: MsgGrantAllowance;
     };
+    /** MsgRevokeAllowance message creator
+     * Revokes any fee allowance of granter's account that has been granted to the grantee.
+     *
+     * @param object Represents the properties available for this MsgRevokeAllowance message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const RevokeAllowance: <I extends {
         granter?: string;
         grantee?: string;
@@ -463,6 +557,12 @@ export declare namespace Feegrant {
  * Module to generate the Messages related to the Bank module of the Blockchain
  */
 export declare namespace Bank {
+    /** MsgMultiSend message creator
+     * Defines a method for sending coins from some accounts to other accounts.
+     *
+     * @param object Represents the properties available for this MsgMultiSend message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const MultiSend: <I extends {
         inputs?: {
             address?: string;
@@ -551,6 +651,12 @@ export declare namespace Bank {
         typeUrl: string;
         value: MsgMultiSend;
     };
+    /** MsgSend message creator
+     * Defines a method for sending coins from one account to another account.
+     *
+     * @param object Represents the properties available for this MsgSend message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const Send: <I extends {
         fromAddress?: string;
         toAddress?: string;
@@ -578,6 +684,11 @@ export declare namespace Bank {
         typeUrl: string;
         value: MsgSend;
     };
+    /** MsgSetSendEnabled message creator
+     *
+     * @param object Represents the properties available for this MsgSetSendEnabled message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const SetSendEnabled: <I extends {
         authority?: string;
         sendEnabled?: {
@@ -605,6 +716,11 @@ export declare namespace Bank {
         typeUrl: string;
         value: MsgSetSendEnabled;
     };
+    /** MsgUpdateParams message creator
+     *
+     * @param object Represents the properties available for this MsgUpdateParams message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const UpdateParams: <I extends {
         authority?: string;
         params?: {
@@ -647,6 +763,12 @@ export declare namespace Bank {
  * Module to generate the Messages related to the Distribution module of the Blockchain
  */
 export declare namespace Distribution {
+    /** MsgWithdrawDelegatorReward message creator
+     * Defines a method to withdraw rewards of delegator from a single validator.
+     *
+     * @param object Represents the properties available for this MsgWithdrawDelegatorReward message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const WithdrawDelegatorReward: <I extends {
         delegatorAddress?: string;
         validatorAddress?: string;
@@ -657,6 +779,11 @@ export declare namespace Distribution {
         typeUrl: string;
         value: MsgWithdrawDelegatorReward;
     };
+    /** MsgUpdateParams message creator
+     *
+     * @param object Represents the properties available for this MsgUpdateParams message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const UpdateParams: <I extends {
         authority?: string;
         params?: {
@@ -682,6 +809,12 @@ export declare namespace Distribution {
         typeUrl: string;
         value: DMsgUpdateParams;
     };
+    /** MsgWithdrawValidatorCommission message creator
+     * Defines a method to withdraw the full commission to the validator address.
+     *
+     * @param object Represents the properties available for this MsgWithdrawValidatorCommission message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const WithdrawValidatorCommission: <I extends {
         validatorAddress?: string;
     } & {
@@ -690,6 +823,11 @@ export declare namespace Distribution {
         typeUrl: string;
         value: MsgWithdrawValidatorCommission;
     };
+    /** MsgCommunityPoolSpend message creator
+     *
+     * @param object Represents the properties available for this MsgCommunityPoolSpend message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const CommunityPoolSpend: <I extends {
         authority?: string;
         recipient?: string;
@@ -717,6 +855,11 @@ export declare namespace Distribution {
         typeUrl: string;
         value: MsgCommunityPoolSpend;
     };
+    /** MsgDepositValidatorRewardsPool message creator
+     *
+     * @param object Represents the properties available for this MsgDepositValidatorRewardsPool message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const DepositValidatorRewardsPool: <I extends {
         depositor?: string;
         validatorAddress?: string;
@@ -744,6 +887,12 @@ export declare namespace Distribution {
         typeUrl: string;
         value: MsgDepositValidatorRewardsPool;
     };
+    /** MsgFundCommunityPool message creator
+     * Defines a method to allow an account to directly fund the community pool.
+     *
+     * @param object Represents the properties available for this MsgUpdateParams message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const FundCommunityPool: <I extends {
         amount?: {
             denom?: string;
@@ -769,6 +918,12 @@ export declare namespace Distribution {
         typeUrl: string;
         value: MsgFundCommunityPool;
     };
+    /** MsgSetWithdrawAddress message creator
+     * Defines a method to change the withdraw address for a delegator (or validator self-delegation).
+     *
+     * @param object Represents the properties available for this MsgSetWithdrawAddress message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const SetWithdrawAddress: <I extends {
         delegatorAddress?: string;
         withdrawAddress?: string;
@@ -784,6 +939,12 @@ export declare namespace Distribution {
  * Module to generate the Messages related to the Vesting module of the Blockchain
  */
 export declare namespace Vesting {
+    /** MsgCreateVestingAccount message creator
+     * Defines a method that enables creating a vesting account.
+     *
+     * @param object Represents the properties available for this MsgCreateVestingAccount message.
+     * @returns A Msg object with the typeUrl and value object for the proper message
+     */
     const CreateVestingAccount: <I extends {
         fromAddress?: string;
         toAddress?: string;