coreum-js 2.6.4 → 2.6.6

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

@@ -5,7 +5,16 @@ import { MsgCommunityPoolSpend, MsgDepositValidatorRewardsPool, MsgFundCommunity
 import { MsgCreatePeriodicVestingAccount, MsgCreatePermanentLockedAccount, MsgCreateVestingAccount } from "./vesting/v1beta1/tx";
 import { MsgBeginRedelegate, MsgCancelUnbondingDelegation, MsgCreateValidator, MsgDelegate, MsgEditValidator, MsgUndelegate, MsgUpdateParams as SMsgUpdateParams } from "./staking/v1beta1/tx";
 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;
@@ -39,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?: {
@@ -64,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;
@@ -77,7 +98,16 @@ export declare namespace Authz {
         value: MsgRevoke;
     };
 }
+/**
+ * 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;
@@ -101,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;
@@ -124,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;
@@ -192,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;
@@ -213,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;
@@ -245,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;
@@ -266,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?: {
@@ -310,7 +374,16 @@ export declare namespace Staking {
         value: SMsgUpdateParams;
     };
 }
+/**
+ * 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;
@@ -338,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;
@@ -374,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;
@@ -386,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;
@@ -414,7 +505,16 @@ export declare namespace Governance {
         value: MsgVoteWeighted;
     };
 }
+/**
+ * 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;
@@ -436,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;
@@ -447,7 +553,16 @@ export declare namespace Feegrant {
         value: MsgRevokeAllowance;
     };
 }
+/**
+ * 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;
@@ -536,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;
@@ -563,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?: {
@@ -590,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?: {
@@ -628,7 +759,16 @@ export declare namespace Bank {
         value: MsgUpdateParams;
     };
 }
+/**
+ * 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;
@@ -639,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?: {
@@ -664,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;
     } & {
@@ -672,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;
@@ -699,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;
@@ -726,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;
@@ -751,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;
@@ -762,7 +935,16 @@ export declare namespace Distribution {
         value: MsgSetWithdrawAddress;
     };
 }
+/**
+ * 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;