From 1ea37cd845682f1ca73509c91ff4eefd14372048 Mon Sep 17 00:00:00 2001 From: joon9823 Date: Fri, 8 Nov 2024 18:15:44 +0900 Subject: [PATCH] Add more comments --- src/client/rest/RESTClient.ts | 2 -- src/core/Coin.ts | 2 -- src/core/Coins.ts | 2 -- src/core/auction/AuctionParams.ts | 3 +++ src/core/auction/msgs/MsgAuctionBid.ts | 3 +++ .../auction/msgs/MsgUpdateAuctionParams.ts | 3 +++ src/core/auth/AuthParams.ts | 3 +++ src/core/auth/BaseAccount.ts | 2 -- src/core/auth/ModuleAccount.ts | 1 - src/core/auth/msgs/MsgUpdateAuthParams.ts | 3 +++ .../authz/authorizations/Authorization.ts | 8 +++++++ .../authorizations/ExecuteAuthorization.ts | 6 +++++ .../authorizations/GenericAuthorization.ts | 6 +++++ .../authorizations/PublishAuthorization.ts | 6 +++++ .../authz/authorizations/SendAuthorization.ts | 8 +++++++ .../authorizations/StakeAuthorization.ts | 9 ++++++++ src/core/authz/msgs/MsgExecAuthorized.ts | 5 +++++ src/core/authz/msgs/MsgGrantAuthorization.ts | 5 +++++ src/core/authz/msgs/MsgRevokeAuthorization.ts | 4 ++++ src/core/bank/BankParams.ts | 3 +++ src/core/bank/DenomMetadata.ts | 3 +++ src/core/bank/DenomUnit.ts | 3 +++ src/core/bank/SendEnabled.ts | 3 +++ src/core/bank/msgs/MsgSetDenomMetadata.ts | 4 ++++ src/core/bank/msgs/MsgSetSendEnabled.ts | 6 +++++ src/core/bank/msgs/MsgUpdateBankParams.ts | 3 +++ src/core/bech32.ts | 11 +++++----- src/core/celestia/Blob.ts | 5 +++++ src/core/celestia/BlobTx.ts | 5 +++++ src/core/celestia/msgs/MsgPayForBlobs.ts | 3 +++ src/core/consensus/ABCIParams.ts | 3 +++ src/core/consensus/BlockParams.ts | 3 +++ src/core/consensus/EvidenceParams.ts | 3 +++ src/core/consensus/ValidatorParams.ts | 3 +++ .../msgs/MsgUpdateConsensusParams.ts | 3 +++ src/core/crisis/msgs/MsgUpdateCrisisParams.ts | 3 +++ src/core/distribution/DistributionParams.ts | 3 +++ src/core/distribution/RewardWeight.ts | 3 +++ .../msgs/MsgCommunityPoolSpend.ts | 2 +- .../msgs/MsgDepositValidatorRewardsPool.ts | 3 +++ .../distribution/msgs/MsgFundCommunityPool.ts | 3 +++ .../msgs/MsgSetWithdrawAddress.ts | 4 +--- .../distribution/msgs/MsgUpdateDistrParams.ts | 3 +++ .../msgs/MsgWithdrawDelegatorReward.ts | 6 +---- .../msgs/MsgWithdrawValidatorCommission.ts | 4 +--- src/core/evidence/Equivocation.ts | 3 +++ src/core/evidence/msgs/MsgSubmitEvidence.ts | 3 +++ src/core/feegrant/msgs/MsgGrantAllowance.ts | 1 - src/core/feegrant/msgs/MsgRevokeAllowance.ts | 1 - .../msgs/MsgClearForwardingAccount.ts | 3 +++ .../msgs/MsgRegisterForwardingAccount.ts | 3 +++ src/core/gov/Deposit.ts | 2 +- src/core/gov/GovParams.ts | 3 +++ src/core/gov/Vesting.ts | 2 +- src/core/gov/Vote.ts | 2 +- src/core/gov/msgs/MsgCancelProposal.ts | 3 +++ src/core/gov/msgs/MsgDeposit.ts | 2 +- src/core/gov/msgs/MsgDepositLegacy.ts | 2 +- src/core/gov/msgs/MsgSubmitProposal.ts | 3 +++ src/core/gov/msgs/MsgSubmitProposalLegacy.ts | 2 +- src/core/gov/msgs/MsgUpdateGovParams.ts | 3 +++ src/core/gov/msgs/MsgVote.ts | 2 +- src/core/gov/msgs/MsgVoteLegacy.ts | 2 +- src/core/gov/msgs/MsgVoteWeighted.ts | 2 +- src/core/gov/msgs/MsgVoteWeightedLegacy.ts | 2 +- src/core/gov/proposals/Proposal.ts | 3 +-- src/core/gov/proposals/TextProposal.ts | 6 ++--- src/core/group/GroupInfo.ts | 3 +++ src/core/group/GroupMember.ts | 11 ++++++++++ src/core/group/GroupPolicyInfo.ts | 3 +++ src/core/group/GroupProposal.ts | 3 +-- src/core/group/GroupVote.ts | 3 +++ src/core/group/msgs/MsgCreateGroup.ts | 3 +++ src/core/group/msgs/MsgCreateGroupPolicy.ts | 3 +++ .../group/msgs/MsgCreateGroupWithPolicy.ts | 3 +++ src/core/group/msgs/MsgGroupExec.ts | 3 +++ src/core/group/msgs/MsgGroupVote.ts | 3 +++ src/core/group/msgs/MsgLeaveGroup.ts | 3 +++ src/core/group/msgs/MsgSubmitGroupProposal.ts | 3 +++ src/core/group/msgs/MsgUpdateGroupAdmin.ts | 3 +++ .../msgs/MsgUpdateGroupDecisionPolicy.ts | 3 +++ src/core/group/msgs/MsgUpdateGroupMembers.ts | 3 +++ src/core/group/msgs/MsgUpdateGroupMetadata.ts | 3 +++ .../group/msgs/MsgUpdateGroupPolicyAdmin.ts | 3 +++ .../msgs/MsgUpdateGroupPolicyMetadata.ts | 3 +++ src/core/group/msgs/MsgWithdrawProposal.ts | 3 +++ .../group/policies/DecisionPolicyWindows.ts | 3 +++ .../policies/PercentageDecisionPolicy.ts | 8 +++++++ .../group/policies/ThresholdDecisionPolicy.ts | 6 +++++ src/core/ibc/applications/fee/IbcFee.ts | 2 +- .../applications/fee/IdentifiedPacketFee.ts | 2 +- src/core/ibc/applications/fee/PacketFee.ts | 2 +- .../interchain-account/controller/Params.ts | 4 ++-- .../interchain-account/host/Params.ts | 4 ++-- .../applications/nft-transfer/IbcNftParams.ts | 3 +++ .../NonFungibleTokenPacketData.ts | 2 +- .../msgs/MsgUpdateIbcNftParams.ts | 5 ++++- .../transfer/FungibleTokenPacketData.ts | 2 +- .../transfer/IbcTransferParams.ts | 3 +++ .../msgs/MsgUpdateIbcTransferParams.ts | 5 ++++- src/core/ibc/core/channel/IbcChannelParams.ts | 3 +++ .../channel/msgs/MsgChannelOpenConfirm.ts | 2 +- .../channel/msgs/MsgUpdateIbcChannelParams.ts | 5 ++++- src/core/ibc/core/client/IbcClientParams.ts | 3 +++ .../core/client/msgs/MsgSubmitMisbehaviour.ts | 2 +- .../client/msgs/MsgUpdateIbcClientParams.ts | 5 ++++- .../core/connection/IbcConnectionParams.ts | 3 +++ .../connection/msgs/MsgConnectionOpenTry.ts | 2 +- .../msgs/MsgUpdateIbcConnectionParams.ts | 5 ++++- src/core/ibchooks/ACL.ts | 3 +++ src/core/ibchooks/IbcHooksParams.ts | 3 +++ src/core/ibchooks/msgs/MsgUpdateACL.ts | 3 +++ .../ibchooks/msgs/MsgUpdateIbcHooksParams.ts | 3 +++ src/core/marketmap/Market.ts | 3 +++ src/core/marketmap/MarketmapParams.ts | 3 +++ src/core/marketmap/Ticker.ts | 5 +++++ src/core/marketmap/msgs/MsgCreateMarkets.ts | 3 +++ .../msgs/MsgRemoveMarketAuthorities.ts | 4 ++++ .../msgs/MsgUpdateMarketmapParams.ts | 5 ++++- src/core/marketmap/msgs/MsgUpdateMarkets.ts | 3 +++ src/core/marketmap/msgs/MsgUpsertMarkets.ts | 5 +++++ src/core/mstaking/Delegation.ts | 2 +- src/core/mstaking/MstakingParams.ts | 3 +++ src/core/mstaking/Redelegation.ts | 14 ++---------- src/core/mstaking/UnbondingDelegation.ts | 11 ++-------- src/core/mstaking/Validator.ts | 3 +-- src/core/mstaking/msgs/MsgBeginRedelegate.ts | 6 ++--- .../msgs/MsgCancelUnbondingDelegation.ts | 4 ++++ src/core/mstaking/msgs/MsgCreateValidator.ts | 4 +--- src/core/mstaking/msgs/MsgDelegate.ts | 4 +--- src/core/mstaking/msgs/MsgEditValidator.ts | 7 +----- src/core/mstaking/msgs/MsgUndelegate.ts | 4 +--- .../mstaking/msgs/MsgUpdateMstakingParams.ts | 3 +++ src/core/ophost/msgs/MsgUpdateOphostParams.ts | 2 +- src/core/oracle/CurrencyPair.ts | 4 ++++ src/core/oracle/QuotePrice.ts | 4 ++++ src/core/oracle/msgs/MsgAddCurrencyPairs.ts | 5 +++++ .../oracle/msgs/MsgRemoveCurrencyPairs.ts | 5 +++++ src/core/params/ParamChange.ts | 3 +++ .../proposals/ParameterChangeProposal.ts | 22 +------------------ src/core/reward/RewardParams.ts | 3 +++ src/core/reward/msgs/MsgUpdateRewardParams.ts | 3 +++ src/core/slashing/SlashingParams.ts | 3 +++ src/core/slashing/ValidatorSigningInfo.ts | 3 +++ src/core/slashing/msgs/MsgUnjail.ts | 9 +++----- .../slashing/msgs/MsgUpdateSlashingParams.ts | 3 +++ src/core/tx/CompactBitArray.ts | 6 +++++ src/core/tx/Fee.ts | 1 - src/core/tx/SignDoc.ts | 1 - src/core/tx/TxInfo.ts | 3 +-- src/core/upgrade/msgs/MsgCancelUpgrade.ts | 1 - src/core/upgrade/msgs/MsgSoftwareUpgrade.ts | 1 - src/core/wasm/WasmParams.ts | 3 +++ src/core/wasm/msgs/MsgUpdateWasmParams.ts | 5 ++++- src/key/Key.ts | 6 ----- src/key/MnemonicKey.ts | 1 - src/key/ledger/LedgerKey.ts | 1 - src/key/ledger/app.ts | 22 +++++++++---------- 158 files changed, 447 insertions(+), 161 deletions(-) diff --git a/src/client/rest/RESTClient.ts b/src/client/rest/RESTClient.ts index 3d5228c..a437168 100644 --- a/src/client/rest/RESTClient.ts +++ b/src/client/rest/RESTClient.ts @@ -115,8 +115,6 @@ export class RESTClient { public wasm: WasmAPI /** - * Creates a new REST client with the specified configuration. - * * @param config REST configuration */ constructor( diff --git a/src/core/Coin.ts b/src/core/Coin.ts index 7e24a6a..94faebd 100644 --- a/src/core/Coin.ts +++ b/src/core/Coin.ts @@ -15,7 +15,6 @@ export class Coin extends JSONSerializable { /** * Creates a new coin. Depending on the type of amount, it will be converted to an * integer coin or decimal coin. - * * @param denom denomination * @param amount coin's amount */ @@ -77,7 +76,6 @@ export class Coin extends JSONSerializable { /** * Creates a new Coin adding to the current value. - * * @param other */ public add(other: number | string | Coin): Coin { diff --git a/src/core/Coins.ts b/src/core/Coins.ts index 701851b..d83d368 100644 --- a/src/core/Coins.ts +++ b/src/core/Coins.ts @@ -5,7 +5,6 @@ import { Denom } from './Denom' /** * Analogous to `sdk.Coins` and `sdk.DecCoins` from Cosmos-SDK, and represents a collection * of [[Coin]] objects. - * */ export class Coins extends JSONSerializable @@ -41,7 +40,6 @@ export class Coins * Converts a comma-separated list of coins to a Coins object * * Eg. `1500uinit,12302uini` - * * @param str comma-separated list of coins */ public static fromString(str: string): Coins { diff --git a/src/core/auction/AuctionParams.ts b/src/core/auction/AuctionParams.ts index 3825671..9ffccc2 100644 --- a/src/core/auction/AuctionParams.ts +++ b/src/core/auction/AuctionParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Coin } from '../Coin' import { Params as Params_pb } from '@initia/initia.proto/sdk/auction/v1/genesis' +/** + * AuctionParams defines the set of auction parameters. + */ export class AuctionParams extends JSONSerializable< AuctionParams.Amino, AuctionParams.Data, diff --git a/src/core/auction/msgs/MsgAuctionBid.ts b/src/core/auction/msgs/MsgAuctionBid.ts index 06b82d0..a18834c 100644 --- a/src/core/auction/msgs/MsgAuctionBid.ts +++ b/src/core/auction/msgs/MsgAuctionBid.ts @@ -4,6 +4,9 @@ import { Coin } from '../../Coin' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgAuctionBid as MsgAuctionBid_pb } from '@initia/initia.proto/sdk/auction/v1/tx' +/** + * MsgAuctionBid defines a method for sending bids to the auction module. + */ export class MsgAuctionBid extends JSONSerializable< MsgAuctionBid.Amino, MsgAuctionBid.Data, diff --git a/src/core/auction/msgs/MsgUpdateAuctionParams.ts b/src/core/auction/msgs/MsgUpdateAuctionParams.ts index a10b2f1..07298e5 100644 --- a/src/core/auction/msgs/MsgUpdateAuctionParams.ts +++ b/src/core/auction/msgs/MsgUpdateAuctionParams.ts @@ -4,6 +4,9 @@ import { AuctionParams } from '../AuctionParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/sdk/auction/v1/tx' +/** + * MsgUpdateAuctionParams defines an operation for updating the auction module parameters. + */ export class MsgUpdateAuctionParams extends JSONSerializable< MsgUpdateAuctionParams.Amino, MsgUpdateAuctionParams.Data, diff --git a/src/core/auth/AuthParams.ts b/src/core/auth/AuthParams.ts index abbc76b..113eeeb 100644 --- a/src/core/auth/AuthParams.ts +++ b/src/core/auth/AuthParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../util/json' import { Params as Params_pb } from '@initia/initia.proto/cosmos/auth/v1beta1/auth' +/** + * AuthParams defines the set of auth parameters. + */ export class AuthParams extends JSONSerializable< AuthParams.Amino, AuthParams.Data, diff --git a/src/core/auth/BaseAccount.ts b/src/core/auth/BaseAccount.ts index 6fea041..21c53fc 100644 --- a/src/core/auth/BaseAccount.ts +++ b/src/core/auth/BaseAccount.ts @@ -13,8 +13,6 @@ export class BaseAccount extends JSONSerializable< BaseAccount.Proto > { /** - * Creates a new Account object, holding information about a basic account. - * * @param address account address * @param coins account's balance * @param public_key account's public key information diff --git a/src/core/auth/ModuleAccount.ts b/src/core/auth/ModuleAccount.ts index 0740c8b..81abc60 100644 --- a/src/core/auth/ModuleAccount.ts +++ b/src/core/auth/ModuleAccount.ts @@ -13,7 +13,6 @@ export class ModuleAccount extends JSONSerializable< ModuleAccount.Proto > { /** - * * @param base_account account information * @param name account's name * @param permissions account's permissions diff --git a/src/core/auth/msgs/MsgUpdateAuthParams.ts b/src/core/auth/msgs/MsgUpdateAuthParams.ts index 2662e39..da044a9 100644 --- a/src/core/auth/msgs/MsgUpdateAuthParams.ts +++ b/src/core/auth/msgs/MsgUpdateAuthParams.ts @@ -4,6 +4,9 @@ import { AuthParams } from '../AuthParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmos/auth/v1beta1/tx' +/** + * MsgUpdateAuthParams defines an operation for updating the auth module parameters. + */ export class MsgUpdateAuthParams extends JSONSerializable< MsgUpdateAuthParams.Amino, MsgUpdateAuthParams.Data, diff --git a/src/core/authz/authorizations/Authorization.ts b/src/core/authz/authorizations/Authorization.ts index 0139aee..37d8d5b 100644 --- a/src/core/authz/authorizations/Authorization.ts +++ b/src/core/authz/authorizations/Authorization.ts @@ -13,11 +13,19 @@ import { TransferAuthorization } from '../../ibc/applications/transfer' import { Any } from '@initia/initia.proto/google/protobuf/any' import { Grant as Grant_pb } from '@initia/initia.proto/cosmos/authz/v1beta1/authz' +/** + * AuthorizationGrant gives permissions to execute the provide method with expiration time. + */ export class AuthorizationGrant extends JSONSerializable< AuthorizationGrant.Amino, AuthorizationGrant.Data, AuthorizationGrant.Proto > { + /** + * @param authorization + * @param expiration time when the grant will expire and will be pruned. If null, then the grant + * doesn't have a time expiration + */ constructor( public authorization: Authorization, public expiration?: Date diff --git a/src/core/authz/authorizations/ExecuteAuthorization.ts b/src/core/authz/authorizations/ExecuteAuthorization.ts index 6e99904..a02eb40 100644 --- a/src/core/authz/authorizations/ExecuteAuthorization.ts +++ b/src/core/authz/authorizations/ExecuteAuthorization.ts @@ -3,11 +3,17 @@ import { ExecuteAuthorization as ExecuteAuthorization_pb } from '@initia/initia. import { ExecuteAuthorizationItem as ExecuteAuthorizationItem_pb } from '@initia/initia.proto/initia/move/v1/types' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * ExecuteAuthorization defines authorization for execute a move function. + */ export class ExecuteAuthorization extends JSONSerializable< ExecuteAuthorization.Amino, ExecuteAuthorization.Data, ExecuteAuthorization.Proto > { + /** + * @param items + */ constructor(public items: ExecuteAuthorizationItem[]) { super() } diff --git a/src/core/authz/authorizations/GenericAuthorization.ts b/src/core/authz/authorizations/GenericAuthorization.ts index 1164f75..8371489 100644 --- a/src/core/authz/authorizations/GenericAuthorization.ts +++ b/src/core/authz/authorizations/GenericAuthorization.ts @@ -2,11 +2,17 @@ import { JSONSerializable } from '../../../util/json' import { GenericAuthorization as GenericAuthorization_pb } from '@initia/initia.proto/cosmos/authz/v1beta1/authz' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * GenericAuthorization gives the grantee unrestricted permissions to execute the provided method on behalf of the granter's account. + */ export class GenericAuthorization extends JSONSerializable< GenericAuthorization.Amino, GenericAuthorization.Data, GenericAuthorization.Proto > { + /** + * @param msg msg, identified by it's type URL, to grant unrestricted permissions to execute + */ constructor(public msg: string) { super() } diff --git a/src/core/authz/authorizations/PublishAuthorization.ts b/src/core/authz/authorizations/PublishAuthorization.ts index 80ca15b..8791e61 100644 --- a/src/core/authz/authorizations/PublishAuthorization.ts +++ b/src/core/authz/authorizations/PublishAuthorization.ts @@ -2,11 +2,17 @@ import { JSONSerializable } from '../../../util/json' import { PublishAuthorization as PublishAuthorization_pb } from '@initia/initia.proto/initia/move/v1/authz' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * PublishAuthorization defines authorization for publish a move module. + */ export class PublishAuthorization extends JSONSerializable< PublishAuthorization.Amino, PublishAuthorization.Data, PublishAuthorization.Proto > { + /** + * @param module_names + */ constructor(public module_names: string[]) { super() } diff --git a/src/core/authz/authorizations/SendAuthorization.ts b/src/core/authz/authorizations/SendAuthorization.ts index f594a8a..7877fab 100644 --- a/src/core/authz/authorizations/SendAuthorization.ts +++ b/src/core/authz/authorizations/SendAuthorization.ts @@ -4,12 +4,20 @@ import { Coins } from '../../Coins' import { SendAuthorization as SendAuthorization_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/authz' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * SendAuthorization allows the grantee to spend up to spend_limit coins from the granter's account. + */ export class SendAuthorization extends JSONSerializable< SendAuthorization.Amino, SendAuthorization.Data, SendAuthorization.Proto > { public spend_limit: Coins + + /** + * @param spend_limit + * @param allow_list an optional list of addresses to whom the grantee can send tokens on behalf of the granter + */ constructor( spend_limit: Coins.Input, public allow_list: AccAddress[] diff --git a/src/core/authz/authorizations/StakeAuthorization.ts b/src/core/authz/authorizations/StakeAuthorization.ts index 0f2bfd8..1038b1e 100644 --- a/src/core/authz/authorizations/StakeAuthorization.ts +++ b/src/core/authz/authorizations/StakeAuthorization.ts @@ -10,6 +10,9 @@ import { } from '@initia/initia.proto/initia/mstaking/v1/authz' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * StakeAuthorization defines authorization for delegate/undelegate/redelegate. + */ export class StakeAuthorization extends JSONSerializable< StakeAuthorization.Amino, StakeAuthorization.Data, @@ -17,6 +20,12 @@ export class StakeAuthorization extends JSONSerializable< > { public max_tokens: Coins + /** + * @param max_tokensthe maximum amount of tokens can be delegate to a validator + * @param allow_list list of validator addresses to whom grantee can delegate tokens on behalf of granter's account + * @param deny_list list of validator addresses to whom grantee can not delegate tokens + * @param authorization_type + */ constructor( max_tokens: Coins.Input, public allow_list: StakeAuthorizationValidators, diff --git a/src/core/authz/msgs/MsgExecAuthorized.ts b/src/core/authz/msgs/MsgExecAuthorized.ts index 5aca2b2..8be6f37 100644 --- a/src/core/authz/msgs/MsgExecAuthorized.ts +++ b/src/core/authz/msgs/MsgExecAuthorized.ts @@ -4,6 +4,11 @@ import { Msg } from '../../Msg' import { MsgExec as MsgExec_pb } from '@initia/initia.proto/cosmos/authz/v1beta1/tx' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * MsgExecAuthorized 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. + */ export class MsgExecAuthorized extends JSONSerializable< MsgExecAuthorized.Amino, MsgExecAuthorized.Data, diff --git a/src/core/authz/msgs/MsgGrantAuthorization.ts b/src/core/authz/msgs/MsgGrantAuthorization.ts index 7e9e2e8..e6ff894 100644 --- a/src/core/authz/msgs/MsgGrantAuthorization.ts +++ b/src/core/authz/msgs/MsgGrantAuthorization.ts @@ -5,6 +5,11 @@ import { MsgGrant as MsgGrant_pb } from '@initia/initia.proto/cosmos/authz/v1bet import { Any } from '@initia/initia.proto/google/protobuf/any' import { Grant as Grant_pb } from '@initia/initia.proto/cosmos/authz/v1beta1/authz' +/** + * MsgGrantAuthorization 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. + */ export class MsgGrantAuthorization extends JSONSerializable< MsgGrantAuthorization.Amino, MsgGrantAuthorization.Data, diff --git a/src/core/authz/msgs/MsgRevokeAuthorization.ts b/src/core/authz/msgs/MsgRevokeAuthorization.ts index e7ff0e8..4f8e0fa 100644 --- a/src/core/authz/msgs/MsgRevokeAuthorization.ts +++ b/src/core/authz/msgs/MsgRevokeAuthorization.ts @@ -3,6 +3,10 @@ import { AccAddress } from '../../bech32' import { MsgRevoke as MsgRevoke_pb } from '@initia/initia.proto/cosmos/authz/v1beta1/tx' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * MsgRevokeAuthorization revokes any authorization corresponding to the provided method name on the + * granter's account that has been granted to the grantee. + */ export class MsgRevokeAuthorization extends JSONSerializable< MsgRevokeAuthorization.Amino, MsgRevokeAuthorization.Data, diff --git a/src/core/bank/BankParams.ts b/src/core/bank/BankParams.ts index 8065e6a..d58e4fc 100644 --- a/src/core/bank/BankParams.ts +++ b/src/core/bank/BankParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { SendEnabled } from './SendEnabled' import { Params as Params_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/bank' +/** + * Bank defines the set of bank parameters. + */ export class BankParams extends JSONSerializable< BankParams.Amino, BankParams.Data, diff --git a/src/core/bank/DenomMetadata.ts b/src/core/bank/DenomMetadata.ts index 903cdbc..361fe4f 100644 --- a/src/core/bank/DenomMetadata.ts +++ b/src/core/bank/DenomMetadata.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { DenomUnit } from './DenomUnit' import { Metadata as Metadata_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/bank' +/** + * DenomMetadata represents a struct that describes a basic token. + */ export class DenomMetadata extends JSONSerializable< DenomMetadata.Amino, DenomMetadata.Data, diff --git a/src/core/bank/DenomUnit.ts b/src/core/bank/DenomUnit.ts index 824bffe..362c409 100644 --- a/src/core/bank/DenomUnit.ts +++ b/src/core/bank/DenomUnit.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Denom } from '../Denom' import { DenomUnit as DenomUnit_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/bank' +/** + * DenomUnit represents a struct that describes a given denomination unit of the basic token. + */ export class DenomUnit extends JSONSerializable< DenomUnit.Amino, DenomUnit.Data, diff --git a/src/core/bank/SendEnabled.ts b/src/core/bank/SendEnabled.ts index d4a46d1..d7336eb 100644 --- a/src/core/bank/SendEnabled.ts +++ b/src/core/bank/SendEnabled.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Denom } from '../Denom' import { SendEnabled as SendEnabled_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/bank' +/** + * SendEnabled maps coin denom to a send_enabled status (whether a denom is sendable). + */ export class SendEnabled extends JSONSerializable< SendEnabled.Amino, SendEnabled.Data, diff --git a/src/core/bank/msgs/MsgSetDenomMetadata.ts b/src/core/bank/msgs/MsgSetDenomMetadata.ts index 4f1c10d..5e0b9b5 100644 --- a/src/core/bank/msgs/MsgSetDenomMetadata.ts +++ b/src/core/bank/msgs/MsgSetDenomMetadata.ts @@ -4,6 +4,10 @@ import { DenomMetadata } from '../DenomMetadata' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSetDenomMetadata as MsgSetDenomMetadata_pb } from '@initia/initia.proto/initia/bank/v1/tx' +/** + * MsgSetDenomMetadata defines a governance operation for updating the bank + * denom metadata. The authority is defined in the keeper. + */ export class MsgSetDenomMetadata extends JSONSerializable< MsgSetDenomMetadata.Amino, MsgSetDenomMetadata.Data, diff --git a/src/core/bank/msgs/MsgSetSendEnabled.ts b/src/core/bank/msgs/MsgSetSendEnabled.ts index 09745e6..9abacc0 100644 --- a/src/core/bank/msgs/MsgSetSendEnabled.ts +++ b/src/core/bank/msgs/MsgSetSendEnabled.ts @@ -5,6 +5,12 @@ import { SendEnabled } from '../SendEnabled' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSetSendEnabled as MsgSetSendEnabled_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/tx' +/** + * MsgSetSendEnabled is a governance operation for setting the SendEnabled flag + * on any number of Denoms. Only the entries to add or update should be + * included. Entries that already exist in the store, but that aren't + * included in this message, will be left unchanged. + */ export class MsgSetSendEnabled extends JSONSerializable< MsgSetSendEnabled.Amino, MsgSetSendEnabled.Data, diff --git a/src/core/bank/msgs/MsgUpdateBankParams.ts b/src/core/bank/msgs/MsgUpdateBankParams.ts index e4e8f96..5467df2 100644 --- a/src/core/bank/msgs/MsgUpdateBankParams.ts +++ b/src/core/bank/msgs/MsgUpdateBankParams.ts @@ -4,6 +4,9 @@ import { BankParams } from '../BankParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmos/bank/v1beta1/tx' +/** + * MsgUpdateBankParams defines an operation for updating the bank module parameters. + */ export class MsgUpdateBankParams extends JSONSerializable< MsgUpdateBankParams.Amino, MsgUpdateBankParams.Data, diff --git a/src/core/bech32.ts b/src/core/bech32.ts index bbb5be1..8c81bf7 100644 --- a/src/core/bech32.ts +++ b/src/core/bech32.ts @@ -31,7 +31,6 @@ function checkPrefixAndLength( export namespace AccAddress { /** * Checks if a string is a valid Initia account address. - * * @param data string to check */ export function validate(data: string): boolean { @@ -43,7 +42,6 @@ export namespace AccAddress { /** * Converts a validator address into an account address - * * @param address validator address */ export function fromValAddress(address: ValAddress): AccAddress { @@ -52,8 +50,7 @@ export namespace AccAddress { } /** - * Converts a account address into a hex address - * + * Converts an account address into a hex address * @param address account address */ export function toHex(address: AccAddress): string { @@ -63,7 +60,6 @@ export namespace AccAddress { /** * Converts a hex address into an account address - * * @param hexAddress hex address */ export function fromHex(hexAddress: string): AccAddress { @@ -82,6 +78,10 @@ export namespace AccAddress { } } + /** + * Converts an account address into a Buffer + * @param address account address + */ export function toBuffer(address: AccAddress): Buffer { const vals = bech32.decode(address) return Buffer.from(bech32.fromWords(vals.words)) @@ -111,7 +111,6 @@ export namespace AccPubKey { export namespace ValAddress { /** * Checks if a string is a Initia validator address. - * * @param data string to check */ export function validate(data: string): boolean { diff --git a/src/core/celestia/Blob.ts b/src/core/celestia/Blob.ts index 20afdad..e14d05b 100644 --- a/src/core/celestia/Blob.ts +++ b/src/core/celestia/Blob.ts @@ -1,6 +1,11 @@ import { JSONSerializable } from '../../util/json' import { Blob as Blob_pb } from '@initia/initia.proto/celestia/blob/v1/blob' +/** + * Blob (named after binary large object) is a chunk of data submitted by a user + * to be published to the Celestia blockchain. The data of a Blob is published + * to a namespace and is encoded into shares based on the format specified by share_version. + */ export class Blob extends JSONSerializable { /** * @param namespace_id diff --git a/src/core/celestia/BlobTx.ts b/src/core/celestia/BlobTx.ts index 7dcfd21..1d819c8 100644 --- a/src/core/celestia/BlobTx.ts +++ b/src/core/celestia/BlobTx.ts @@ -3,6 +3,11 @@ import { Tx } from '../tx/Tx' import { Blob } from './Blob' import { BlobTx as BlobTx_pb } from '@initia/initia.proto/celestia/blob/v1/blob' +/** + * BlobTx wraps an encoded sdk.Tx with a second field to contain blobs of data. + * The raw bytes of the blobs are not signed over, instead we verify each blob + * using the relevant MsgPayForBlobs that is signed over in the encoded sdk.Tx. + */ export class BlobTx extends JSONSerializable { /** * @param tx diff --git a/src/core/celestia/msgs/MsgPayForBlobs.ts b/src/core/celestia/msgs/MsgPayForBlobs.ts index dad6198..72c8d7b 100644 --- a/src/core/celestia/msgs/MsgPayForBlobs.ts +++ b/src/core/celestia/msgs/MsgPayForBlobs.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgPayForBlobs as MsgPayForBlobs_pb } from '@initia/initia.proto/celestia/blob/v1/tx' +/** + * MsgPayForBlobs pays for the inclusion of a blob in the block. + */ export class MsgPayForBlobs extends JSONSerializable< any, MsgPayForBlobs.Data, diff --git a/src/core/consensus/ABCIParams.ts b/src/core/consensus/ABCIParams.ts index aadf00c..7de51e7 100644 --- a/src/core/consensus/ABCIParams.ts +++ b/src/core/consensus/ABCIParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../util/json' import { ABCIParams as ABCIParams_pb } from '@initia/initia.proto/tendermint/types/params' +/** + * ABCIParams defines the set of abci parameters. + */ export class ABCIParams extends JSONSerializable< ABCIParams.Amino, ABCIParams.Data, diff --git a/src/core/consensus/BlockParams.ts b/src/core/consensus/BlockParams.ts index 6945690..a5a1ebd 100644 --- a/src/core/consensus/BlockParams.ts +++ b/src/core/consensus/BlockParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../util/json' import { BlockParams as BlockParams_pb } from '@initia/initia.proto/tendermint/types/params' +/** + * BlockParams defines the set of block parameters. + */ export class BlockParams extends JSONSerializable< BlockParams.Amino, BlockParams.Data, diff --git a/src/core/consensus/EvidenceParams.ts b/src/core/consensus/EvidenceParams.ts index 5ec2186..e23d588 100644 --- a/src/core/consensus/EvidenceParams.ts +++ b/src/core/consensus/EvidenceParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Duration } from '../Duration' import { EvidenceParams as EvidenceParams_pb } from '@initia/initia.proto/tendermint/types/params' +/** + * EvidenceParams defines the set of evidence parameters. + */ export class EvidenceParams extends JSONSerializable< EvidenceParams.Amino, EvidenceParams.Data, diff --git a/src/core/consensus/ValidatorParams.ts b/src/core/consensus/ValidatorParams.ts index 6ba1e02..21c9729 100644 --- a/src/core/consensus/ValidatorParams.ts +++ b/src/core/consensus/ValidatorParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../util/json' import { ValidatorParams as ValidatorParams_pb } from '@initia/initia.proto/tendermint/types/params' +/** + * ValidatorParams defines the set of validator parameters. + */ export class ValidatorParams extends JSONSerializable< ValidatorParams.Amino, ValidatorParams.Data, diff --git a/src/core/consensus/msgs/MsgUpdateConsensusParams.ts b/src/core/consensus/msgs/MsgUpdateConsensusParams.ts index ff84d98..a222863 100644 --- a/src/core/consensus/msgs/MsgUpdateConsensusParams.ts +++ b/src/core/consensus/msgs/MsgUpdateConsensusParams.ts @@ -7,6 +7,9 @@ import { ABCIParams } from '../ABCIParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmos/consensus/v1/tx' +/** + * MsgUpdateConsensusParams defines an operation for updating the consensus module parameters. + */ export class MsgUpdateConsensusParams extends JSONSerializable< MsgUpdateConsensusParams.Amino, MsgUpdateConsensusParams.Data, diff --git a/src/core/crisis/msgs/MsgUpdateCrisisParams.ts b/src/core/crisis/msgs/MsgUpdateCrisisParams.ts index 9db013e..8b51626 100644 --- a/src/core/crisis/msgs/MsgUpdateCrisisParams.ts +++ b/src/core/crisis/msgs/MsgUpdateCrisisParams.ts @@ -4,6 +4,9 @@ import { Coin } from '../../Coin' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmos/crisis/v1beta1/tx' +/** + * MsgUpdateCrisisParams defines an operation for updating the crisis module parameters. + */ export class MsgUpdateCrisisParams extends JSONSerializable< MsgUpdateCrisisParams.Amino, MsgUpdateCrisisParams.Data, diff --git a/src/core/distribution/DistributionParams.ts b/src/core/distribution/DistributionParams.ts index ea12198..f57112b 100644 --- a/src/core/distribution/DistributionParams.ts +++ b/src/core/distribution/DistributionParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { RewardWeight } from './RewardWeight' import { Params as Params_pb } from '@initia/initia.proto/initia/distribution/v1/distribution' +/** + * DistributionParams defines the set of distribution parameters. + */ export class DistributionParams extends JSONSerializable< DistributionParams.Amino, DistributionParams.Data, diff --git a/src/core/distribution/RewardWeight.ts b/src/core/distribution/RewardWeight.ts index 9e7fff5..522d733 100644 --- a/src/core/distribution/RewardWeight.ts +++ b/src/core/distribution/RewardWeight.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Denom } from '../Denom' import { RewardWeight as RewardWeight_pb } from '@initia/initia.proto/initia/distribution/v1/distribution' +/** + * RewardWeight represents reward allocation ratio between pools. + */ export class RewardWeight extends JSONSerializable< RewardWeight.Amino, RewardWeight.Data, diff --git a/src/core/distribution/msgs/MsgCommunityPoolSpend.ts b/src/core/distribution/msgs/MsgCommunityPoolSpend.ts index c4fc72b..1261e51 100644 --- a/src/core/distribution/msgs/MsgCommunityPoolSpend.ts +++ b/src/core/distribution/msgs/MsgCommunityPoolSpend.ts @@ -5,7 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgCommunityPoolSpend as MsgCommunityPoolSpend_pb } from '@initia/initia.proto/cosmos/distribution/v1beta1/tx' /** - * defines a message for sending tokens from the community pool to another account + * MsgCommunityPoolSpend defines a message for sending tokens from the community pool to another account. */ export class MsgCommunityPoolSpend extends JSONSerializable< MsgCommunityPoolSpend.Amino, diff --git a/src/core/distribution/msgs/MsgDepositValidatorRewardsPool.ts b/src/core/distribution/msgs/MsgDepositValidatorRewardsPool.ts index 6edc12c..91b9f85 100644 --- a/src/core/distribution/msgs/MsgDepositValidatorRewardsPool.ts +++ b/src/core/distribution/msgs/MsgDepositValidatorRewardsPool.ts @@ -5,6 +5,9 @@ import { Denom } from '../../Denom' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgDepositValidatorRewardsPool as MsgDepositValidatorRewardsPool_pb } from '@initia/initia.proto/initia/distribution/v1/tx' +/** + * MsgDepositValidatorRewardsPool defines a method to provide additional rewards to delegators to a specific validator. + */ export class MsgDepositValidatorRewardsPool extends JSONSerializable< MsgDepositValidatorRewardsPool.Amino, MsgDepositValidatorRewardsPool.Data, diff --git a/src/core/distribution/msgs/MsgFundCommunityPool.ts b/src/core/distribution/msgs/MsgFundCommunityPool.ts index fc10ce7..f3f2a0e 100644 --- a/src/core/distribution/msgs/MsgFundCommunityPool.ts +++ b/src/core/distribution/msgs/MsgFundCommunityPool.ts @@ -4,6 +4,9 @@ import { Coins } from '../../Coins' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgFundCommunityPool as MsgFundCommunityPool_pb } from '@initia/initia.proto/cosmos/distribution/v1beta1/tx' +/** + * MsgFundCommunityPool defines a method to allow an account to directly fund the community pool. + */ export class MsgFundCommunityPool extends JSONSerializable< MsgFundCommunityPool.Amino, MsgFundCommunityPool.Data, diff --git a/src/core/distribution/msgs/MsgSetWithdrawAddress.ts b/src/core/distribution/msgs/MsgSetWithdrawAddress.ts index 164b321..8b209ff 100644 --- a/src/core/distribution/msgs/MsgSetWithdrawAddress.ts +++ b/src/core/distribution/msgs/MsgSetWithdrawAddress.ts @@ -4,9 +4,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSetWithdrawAddress as MsgSetWithdrawAddress_pb } from '@initia/initia.proto/cosmos/distribution/v1beta1/tx' /** - * A validator can withdraw their outstanding commission rewards accrued from all - * delegations (not including its self-delegation) into their associated account's - * withdraw address. + * MsgSetWithdrawAddress defines a method to change the withdraw address for a delegator (or validator self-delegation). */ export class MsgSetWithdrawAddress extends JSONSerializable< MsgSetWithdrawAddress.Amino, diff --git a/src/core/distribution/msgs/MsgUpdateDistrParams.ts b/src/core/distribution/msgs/MsgUpdateDistrParams.ts index 9d42924..b734853 100644 --- a/src/core/distribution/msgs/MsgUpdateDistrParams.ts +++ b/src/core/distribution/msgs/MsgUpdateDistrParams.ts @@ -4,6 +4,9 @@ import { DistributionParams } from '../DistributionParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/initia/distribution/v1/tx' +/** + * MsgUpdateDistrParams defines an operation for updating the distribution module parameters. + */ export class MsgUpdateDistrParams extends JSONSerializable< MsgUpdateDistrParams.Amino, MsgUpdateDistrParams.Data, diff --git a/src/core/distribution/msgs/MsgWithdrawDelegatorReward.ts b/src/core/distribution/msgs/MsgWithdrawDelegatorReward.ts index 246551e..18d7b50 100644 --- a/src/core/distribution/msgs/MsgWithdrawDelegatorReward.ts +++ b/src/core/distribution/msgs/MsgWithdrawDelegatorReward.ts @@ -4,10 +4,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgWithdrawDelegatorReward as MsgWithdrawDelegatorReward_pb } from '@initia/initia.proto/cosmos/distribution/v1beta1/tx' /** - * A delegator can withdraw currently outstanding rewards accrued from their delegation - * toward a validator by submitting the following message. - * - * The rewards will be deposited to their Withdraw Address. + * MsgWithdrawDelegatorReward defines a method to withdraw rewards of delegator from a single validator. */ export class MsgWithdrawDelegatorReward extends JSONSerializable< MsgWithdrawDelegatorReward.Amino, @@ -15,7 +12,6 @@ export class MsgWithdrawDelegatorReward extends JSONSerializable< MsgWithdrawDelegatorReward.Proto > { /** - * * @param delegator_address delegator's account address * @param validator_address validator's operator address */ diff --git a/src/core/distribution/msgs/MsgWithdrawValidatorCommission.ts b/src/core/distribution/msgs/MsgWithdrawValidatorCommission.ts index 4182893..7e9c534 100644 --- a/src/core/distribution/msgs/MsgWithdrawValidatorCommission.ts +++ b/src/core/distribution/msgs/MsgWithdrawValidatorCommission.ts @@ -4,9 +4,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgWithdrawValidatorCommission as MsgWithdrawValidatorCommission_pb } from '@initia/initia.proto/cosmos/distribution/v1beta1/tx' /** - * A validator can withdraw their outstanding commission rewards accrued from all - * delegations (not including its self-delegation) into their associated account's - * withdraw address. + * MsgWithdrawValidatorCommission defines a method to withdraw the full commission to the validator address. */ export class MsgWithdrawValidatorCommission extends JSONSerializable< MsgWithdrawValidatorCommission.Amino, diff --git a/src/core/evidence/Equivocation.ts b/src/core/evidence/Equivocation.ts index d340f4c..d91c239 100644 --- a/src/core/evidence/Equivocation.ts +++ b/src/core/evidence/Equivocation.ts @@ -3,6 +3,9 @@ import { ValConsAddress } from '../bech32' import { Equivocation as Equivocation_pb } from '@initia/initia.proto/cosmos/evidence/v1beta1/evidence' import { Any } from '@initia/initia.proto/google/protobuf/any' +/** + * Equivocation implements the Evidence interface and defines evidence of double signing misbehavior. + */ export class Equivocation extends JSONSerializable< Equivocation.Amino, Equivocation.Data, diff --git a/src/core/evidence/msgs/MsgSubmitEvidence.ts b/src/core/evidence/msgs/MsgSubmitEvidence.ts index 8656e9f..cc4dcd5 100644 --- a/src/core/evidence/msgs/MsgSubmitEvidence.ts +++ b/src/core/evidence/msgs/MsgSubmitEvidence.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSubmitEvidence as MsgSubmitEvidence_pb } from '@initia/initia.proto/cosmos/evidence/v1beta1/tx' import { Evidence } from '../Evidence' +/** + * MsgSubmitEvidence submits an arbitrary Evidence of misbehavior such as equivocation or counterfactual signing. + */ export class MsgSubmitEvidence extends JSONSerializable< MsgSubmitEvidence.Amino, MsgSubmitEvidence.Data, diff --git a/src/core/feegrant/msgs/MsgGrantAllowance.ts b/src/core/feegrant/msgs/MsgGrantAllowance.ts index 1495372..585a58d 100644 --- a/src/core/feegrant/msgs/MsgGrantAllowance.ts +++ b/src/core/feegrant/msgs/MsgGrantAllowance.ts @@ -14,7 +14,6 @@ export class MsgGrantAllowance extends JSONSerializable< MsgGrantAllowance.Proto > { /** - * * @param granter granter's account address * @param grantee grantee's account address * @param allowance allowance willing to grant diff --git a/src/core/feegrant/msgs/MsgRevokeAllowance.ts b/src/core/feegrant/msgs/MsgRevokeAllowance.ts index 7f7f653..2f586a8 100644 --- a/src/core/feegrant/msgs/MsgRevokeAllowance.ts +++ b/src/core/feegrant/msgs/MsgRevokeAllowance.ts @@ -12,7 +12,6 @@ export class MsgRevokeAllowance extends JSONSerializable< MsgRevokeAllowance.Proto > { /** - * * @param granter granter's account address * @param grantee grantee's account address */ diff --git a/src/core/forwarding/msgs/MsgClearForwardingAccount.ts b/src/core/forwarding/msgs/MsgClearForwardingAccount.ts index d4fa67f..790a988 100644 --- a/src/core/forwarding/msgs/MsgClearForwardingAccount.ts +++ b/src/core/forwarding/msgs/MsgClearForwardingAccount.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgClearAccount as MsgClearAccount_pb } from '@initia/initia.proto/noble/forwarding/v1/tx' +/** + * MsgClearForwardingAccount manually clears funds inside forwarding account. + */ export class MsgClearForwardingAccount extends JSONSerializable< MsgClearForwardingAccount.Amino, MsgClearForwardingAccount.Data, diff --git a/src/core/forwarding/msgs/MsgRegisterForwardingAccount.ts b/src/core/forwarding/msgs/MsgRegisterForwardingAccount.ts index e37f166..564fa43 100644 --- a/src/core/forwarding/msgs/MsgRegisterForwardingAccount.ts +++ b/src/core/forwarding/msgs/MsgRegisterForwardingAccount.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgRegisterAccount as MsgRegisterAccount_pb } from '@initia/initia.proto/noble/forwarding/v1/tx' +/** + * MsgRegisterForwardingAccount registers a forwarding account for a channel and recipient. + */ export class MsgRegisterForwardingAccount extends JSONSerializable< MsgRegisterForwardingAccount.Amino, MsgRegisterForwardingAccount.Data, diff --git a/src/core/gov/Deposit.ts b/src/core/gov/Deposit.ts index 2620540..de0c1c2 100644 --- a/src/core/gov/Deposit.ts +++ b/src/core/gov/Deposit.ts @@ -4,7 +4,7 @@ import { AccAddress } from '../bech32' import { Deposit as Deposit_pb } from '@initia/initia.proto/cosmos/gov/v1/gov' /** - * Defines an amount deposited by an account address to an active proposal + * Deposit defines an amount deposited by an account address to an active proposal. */ export class Deposit extends JSONSerializable< Deposit.Amino, diff --git a/src/core/gov/GovParams.ts b/src/core/gov/GovParams.ts index 40cd777..b3c85e6 100644 --- a/src/core/gov/GovParams.ts +++ b/src/core/gov/GovParams.ts @@ -5,6 +5,9 @@ import { Duration } from '../Duration' import { Vesting } from './Vesting' import { Params as Params_pb } from '@initia/initia.proto/initia/gov/v1/gov' +/** + * GovParams defines the set of gov parameters. + */ export class GovParams extends JSONSerializable< GovParams.Amino, GovParams.Data, diff --git a/src/core/gov/Vesting.ts b/src/core/gov/Vesting.ts index 8038621..acd8d9e 100644 --- a/src/core/gov/Vesting.ts +++ b/src/core/gov/Vesting.ts @@ -3,7 +3,7 @@ import { AccAddress } from '../bech32' import { Vesting as Vesting_pb } from '@initia/initia.proto/initia/gov/v1/gov' /** - * Defines an amount Vestinged by an account address to an active proposal + * Vesting defines an amount vested by an account address to an active proposal. */ export class Vesting extends JSONSerializable< Vesting.Amino, diff --git a/src/core/gov/Vote.ts b/src/core/gov/Vote.ts index 158a518..d201ecf 100644 --- a/src/core/gov/Vote.ts +++ b/src/core/gov/Vote.ts @@ -7,7 +7,7 @@ import { } from '@initia/initia.proto/cosmos/gov/v1/gov' /** - * Defines a vote on a governance proposal + * Vote defines a vote on a governance proposal. */ export class Vote extends JSONSerializable { /** diff --git a/src/core/gov/msgs/MsgCancelProposal.ts b/src/core/gov/msgs/MsgCancelProposal.ts index b17625b..83106dc 100644 --- a/src/core/gov/msgs/MsgCancelProposal.ts +++ b/src/core/gov/msgs/MsgCancelProposal.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgCancelProposal as MsgCancelProposal_pb } from '@initia/initia.proto/cosmos/gov/v1/tx' +/** + * MsgCancelProposal defines a method to cancel governance proposal. + */ export class MsgCancelProposal extends JSONSerializable< MsgCancelProposal.Amino, MsgCancelProposal.Data, diff --git a/src/core/gov/msgs/MsgDeposit.ts b/src/core/gov/msgs/MsgDeposit.ts index 9b6f820..49a3000 100644 --- a/src/core/gov/msgs/MsgDeposit.ts +++ b/src/core/gov/msgs/MsgDeposit.ts @@ -5,7 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgDeposit as MsgDeposit_pb } from '@initia/initia.proto/cosmos/gov/v1/tx' /** - * Defines a message to submit a deposit to an existing proposal + * MsgDeposit defines a message to submit a deposit to an existing proposal. */ export class MsgDeposit extends JSONSerializable< MsgDeposit.Amino, diff --git a/src/core/gov/msgs/MsgDepositLegacy.ts b/src/core/gov/msgs/MsgDepositLegacy.ts index 37f0fbf..05a9a81 100644 --- a/src/core/gov/msgs/MsgDepositLegacy.ts +++ b/src/core/gov/msgs/MsgDepositLegacy.ts @@ -5,7 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgDeposit as MsgDeposit_pb } from '@initia/initia.proto/cosmos/gov/v1beta1/tx' /** - * Add a deposit for a proposal + * MsgDepositLegacy adds a deposit for a proposal. */ export class MsgDepositLegacy extends JSONSerializable< MsgDepositLegacy.Amino, diff --git a/src/core/gov/msgs/MsgSubmitProposal.ts b/src/core/gov/msgs/MsgSubmitProposal.ts index b3b5c25..f69e6ce 100644 --- a/src/core/gov/msgs/MsgSubmitProposal.ts +++ b/src/core/gov/msgs/MsgSubmitProposal.ts @@ -5,6 +5,9 @@ import { Coins } from '../../Coins' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSubmitProposal as MsgSubmitProposal_pb } from '@initia/initia.proto/cosmos/gov/v1/tx' +/** + * MsgSubmitProposal defines a method to create new proposal given the messages. + */ export class MsgSubmitProposal extends JSONSerializable< MsgSubmitProposal.Amino, MsgSubmitProposal.Data, diff --git a/src/core/gov/msgs/MsgSubmitProposalLegacy.ts b/src/core/gov/msgs/MsgSubmitProposalLegacy.ts index 488c63a..e4c076b 100644 --- a/src/core/gov/msgs/MsgSubmitProposalLegacy.ts +++ b/src/core/gov/msgs/MsgSubmitProposalLegacy.ts @@ -6,7 +6,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSubmitProposal as MsgSubmitProposal_pb } from '@initia/initia.proto/cosmos/gov/v1beta1/tx' /** - * Submit a proposal alongside an initial deposit. + * MsgSubmitProposalLegacy submits a proposal alongside an initial deposit. */ export class MsgSubmitProposalLegacy extends JSONSerializable< MsgSubmitProposalLegacy.Amino, diff --git a/src/core/gov/msgs/MsgUpdateGovParams.ts b/src/core/gov/msgs/MsgUpdateGovParams.ts index 0f2c2e2..f622270 100644 --- a/src/core/gov/msgs/MsgUpdateGovParams.ts +++ b/src/core/gov/msgs/MsgUpdateGovParams.ts @@ -4,6 +4,9 @@ import { GovParams } from '../GovParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/initia/gov/v1/tx' +/** + * MsgUpdateGovParams defines an operation for updating the gov module parameters. + */ export class MsgUpdateGovParams extends JSONSerializable< MsgUpdateGovParams.Amino, MsgUpdateGovParams.Data, diff --git a/src/core/gov/msgs/MsgVote.ts b/src/core/gov/msgs/MsgVote.ts index ea2a49c..b5c623e 100644 --- a/src/core/gov/msgs/MsgVote.ts +++ b/src/core/gov/msgs/MsgVote.ts @@ -5,7 +5,7 @@ import { MsgVote as MsgVote_pb } from '@initia/initia.proto/cosmos/gov/v1/tx' import { VoteOption } from '@initia/initia.proto/cosmos/gov/v1/gov' /** - * Defines a message to cast a vote + * MsgVote defines a message to cast a vote. */ export class MsgVote extends JSONSerializable< MsgVote.Amino, diff --git a/src/core/gov/msgs/MsgVoteLegacy.ts b/src/core/gov/msgs/MsgVoteLegacy.ts index c58100a..ccd321d 100644 --- a/src/core/gov/msgs/MsgVoteLegacy.ts +++ b/src/core/gov/msgs/MsgVoteLegacy.ts @@ -5,7 +5,7 @@ import { MsgVote as MsgVote_pb } from '@initia/initia.proto/cosmos/gov/v1beta1/t import { VoteOption } from '@initia/initia.proto/cosmos/gov/v1beta1/gov' /** - * Vote for a proposal + * MsgVoteLegacy votes for a proposal. */ export class MsgVoteLegacy extends JSONSerializable< MsgVoteLegacy.Amino, diff --git a/src/core/gov/msgs/MsgVoteWeighted.ts b/src/core/gov/msgs/MsgVoteWeighted.ts index 5f39448..3be0e9c 100644 --- a/src/core/gov/msgs/MsgVoteWeighted.ts +++ b/src/core/gov/msgs/MsgVoteWeighted.ts @@ -5,7 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgVoteWeighted as MsgVoteWeighted_pb } from '@initia/initia.proto/cosmos/gov/v1/tx' /** - * Defines a message to cast a vote + * MsgVoteWeighted defines a message to cast a vote. */ export class MsgVoteWeighted extends JSONSerializable< MsgVoteWeighted.Amino, diff --git a/src/core/gov/msgs/MsgVoteWeightedLegacy.ts b/src/core/gov/msgs/MsgVoteWeightedLegacy.ts index be882c3..40fa29c 100644 --- a/src/core/gov/msgs/MsgVoteWeightedLegacy.ts +++ b/src/core/gov/msgs/MsgVoteWeightedLegacy.ts @@ -5,7 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgVoteWeighted as MsgVoteWeighted_pb } from '@initia/initia.proto/cosmos/gov/v1beta1/tx' /** - * Weighted vote for a proposal + * MsgVoteWeightedLegacy defines weighted vote for a proposal. */ export class MsgVoteWeightedLegacy extends JSONSerializable< MsgVoteWeightedLegacy.Amino, diff --git a/src/core/gov/proposals/Proposal.ts b/src/core/gov/proposals/Proposal.ts index 97b668b..ff53b32 100644 --- a/src/core/gov/proposals/Proposal.ts +++ b/src/core/gov/proposals/Proposal.ts @@ -11,7 +11,7 @@ import { import { Proposal as Proposal_pb } from '@initia/initia.proto/initia/gov/v1/gov' /** - * Defines the core field members of a governance proposal + * Proposal defines the core field members of a governance proposal. */ export class Proposal extends JSONSerializable< Proposal.Amino, @@ -21,7 +21,6 @@ export class Proposal extends JSONSerializable< public total_deposit: Coins /** - * * @param id the unique id of the proposal * @param messages the arbitrary messages to be executed if the proposal passes * @param status the proposal status diff --git a/src/core/gov/proposals/TextProposal.ts b/src/core/gov/proposals/TextProposal.ts index f4f06a9..ea05d08 100644 --- a/src/core/gov/proposals/TextProposal.ts +++ b/src/core/gov/proposals/TextProposal.ts @@ -3,9 +3,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { TextProposal as TextProposal_pb } from '@initia/initia.proto/cosmos/gov/v1beta1/gov' /** - * Basic proposal which describes the candidate proposition that must be put into effect - * manually if passed. Used as a general-purpose way of discovering community's - * sentiment / interest for an arbitrary change. + * TextProposal defines a basic proposal which describes the candidate proposition + * that must be put into effect manually if passed. Used as a general-purpose way of + * discovering community's sentiment / interest for an arbitrary change. */ export class TextProposal extends JSONSerializable< TextProposal.Amino, diff --git a/src/core/group/GroupInfo.ts b/src/core/group/GroupInfo.ts index c8b6b01..3daaa4b 100644 --- a/src/core/group/GroupInfo.ts +++ b/src/core/group/GroupInfo.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { AccAddress } from '../bech32' import { GroupInfo as GroupInfo_pb } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * GroupInfo represents the high-level on-chain information for a group. + */ export class GroupInfo extends JSONSerializable< GroupInfo.Amino, GroupInfo.Data, diff --git a/src/core/group/GroupMember.ts b/src/core/group/GroupMember.ts index 697a184..7dfc80a 100644 --- a/src/core/group/GroupMember.ts +++ b/src/core/group/GroupMember.ts @@ -6,6 +6,9 @@ import { MemberRequest as MemberRequest_pb, } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * GroupMember represents the relationship between a group and a member. + */ export class GroupMember extends JSONSerializable< GroupMember.Amino, GroupMember.Data, @@ -78,6 +81,9 @@ export namespace GroupMember { export type Proto = GroupMember_pb } +/** + * Member represents a group member with an account address, non-zero weight, metadata and added_at timestamp. + */ export class Member extends JSONSerializable< Member.Amino, Member.Data, @@ -166,6 +172,11 @@ export namespace Member { export type Proto = Member_pb } +/** + * MemberRequest represents a group member to be used in Msg server requests. + * Contrary to `Member`, it doesn't have any `added_at` field + * since this field cannot be set as part of requests. + */ export class MemberRequest extends JSONSerializable< MemberRequest.Amino, MemberRequest.Data, diff --git a/src/core/group/GroupPolicyInfo.ts b/src/core/group/GroupPolicyInfo.ts index 20fa23f..5f30fe3 100644 --- a/src/core/group/GroupPolicyInfo.ts +++ b/src/core/group/GroupPolicyInfo.ts @@ -4,6 +4,9 @@ import { DecisionPolicy } from './policies' import { Any } from '@initia/initia.proto/google/protobuf/any' import { GroupPolicyInfo as GroupPolicyInfo_pb } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * GroupPolicyInfo represents the high-level on-chain information for a group policy. + */ export class GroupPolicyInfo extends JSONSerializable< GroupPolicyInfo.Amino, GroupPolicyInfo.Data, diff --git a/src/core/group/GroupProposal.ts b/src/core/group/GroupProposal.ts index 8a4f09c..7eca98d 100644 --- a/src/core/group/GroupProposal.ts +++ b/src/core/group/GroupProposal.ts @@ -14,7 +14,7 @@ import { } from '@initia/initia.proto/cosmos/group/v1/types' /** - * A group proposal consists of a set of `sdk.Msg`s that will be executed if the proposal + * GroupProposal consists of a set of `sdk.Msg`s that will be executed if the proposal * passes as well as some optional metadata associated with the proposal */ export class GroupProposal extends JSONSerializable< @@ -23,7 +23,6 @@ export class GroupProposal extends JSONSerializable< GroupProposal.Proto > { /** - * * @param id the unique id of the proposal * @param group_policy_address the account address of group policy * @param metadata any arbitrary metadata attached to the proposal diff --git a/src/core/group/GroupVote.ts b/src/core/group/GroupVote.ts index 58003f2..32d8d88 100644 --- a/src/core/group/GroupVote.ts +++ b/src/core/group/GroupVote.ts @@ -7,6 +7,9 @@ import { voteOptionToJSON, } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * GroupVote represents a vote for a group proposal. + */ export class GroupVote extends JSONSerializable< GroupVote.Amino, GroupVote.Data, diff --git a/src/core/group/msgs/MsgCreateGroup.ts b/src/core/group/msgs/MsgCreateGroup.ts index 76c9dca..d166d2f 100644 --- a/src/core/group/msgs/MsgCreateGroup.ts +++ b/src/core/group/msgs/MsgCreateGroup.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MemberRequest } from '../GroupMember' import { MsgCreateGroup as MsgCreateGroup_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgCreateGroup creates a new group with an admin account address, a list of members and some optional metadata. + */ export class MsgCreateGroup extends JSONSerializable< MsgCreateGroup.Amino, MsgCreateGroup.Data, diff --git a/src/core/group/msgs/MsgCreateGroupPolicy.ts b/src/core/group/msgs/MsgCreateGroupPolicy.ts index 288160b..5ac2aa1 100644 --- a/src/core/group/msgs/MsgCreateGroupPolicy.ts +++ b/src/core/group/msgs/MsgCreateGroupPolicy.ts @@ -4,6 +4,9 @@ import { DecisionPolicy } from '../policies' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgCreateGroupPolicy as MsgCreateGroupPolicy_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgCreateGroupPolicy creates a new group policy using given DecisionPolicy. + */ export class MsgCreateGroupPolicy extends JSONSerializable< MsgCreateGroupPolicy.Amino, MsgCreateGroupPolicy.Data, diff --git a/src/core/group/msgs/MsgCreateGroupWithPolicy.ts b/src/core/group/msgs/MsgCreateGroupWithPolicy.ts index 2e64758..6bccda6 100644 --- a/src/core/group/msgs/MsgCreateGroupWithPolicy.ts +++ b/src/core/group/msgs/MsgCreateGroupWithPolicy.ts @@ -5,6 +5,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MemberRequest } from '../GroupMember' import { MsgCreateGroupWithPolicy as MsgCreateGroupWithPolicy_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgCreateGroupWithPolicy creates a new group with policy. + */ export class MsgCreateGroupWithPolicy extends JSONSerializable< MsgCreateGroupWithPolicy.Amino, MsgCreateGroupWithPolicy.Data, diff --git a/src/core/group/msgs/MsgGroupExec.ts b/src/core/group/msgs/MsgGroupExec.ts index 54e46b8..7d457e6 100644 --- a/src/core/group/msgs/MsgGroupExec.ts +++ b/src/core/group/msgs/MsgGroupExec.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgExec as MsgExec_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgGroupExec executes a group proposal. + */ export class MsgGroupExec extends JSONSerializable< MsgGroupExec.Amino, MsgGroupExec.Data, diff --git a/src/core/group/msgs/MsgGroupVote.ts b/src/core/group/msgs/MsgGroupVote.ts index 1b19a9f..6a67875 100644 --- a/src/core/group/msgs/MsgGroupVote.ts +++ b/src/core/group/msgs/MsgGroupVote.ts @@ -13,6 +13,9 @@ import { voteOptionToJSON, } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * MsgGroupVote allows a voter to vote on a group proposal. + */ export class MsgGroupVote extends JSONSerializable< MsgGroupVote.Amino, MsgGroupVote.Data, diff --git a/src/core/group/msgs/MsgLeaveGroup.ts b/src/core/group/msgs/MsgLeaveGroup.ts index aef09aa..2f1a541 100644 --- a/src/core/group/msgs/MsgLeaveGroup.ts +++ b/src/core/group/msgs/MsgLeaveGroup.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgLeaveGroup as MsgLeaveGroup_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgLeaveGroup allows a group member to leave the group. + */ export class MsgLeaveGroup extends JSONSerializable< MsgLeaveGroup.Amino, MsgLeaveGroup.Data, diff --git a/src/core/group/msgs/MsgSubmitGroupProposal.ts b/src/core/group/msgs/MsgSubmitGroupProposal.ts index e4fd3e8..c811e77 100644 --- a/src/core/group/msgs/MsgSubmitGroupProposal.ts +++ b/src/core/group/msgs/MsgSubmitGroupProposal.ts @@ -9,6 +9,9 @@ import { execToJSON, } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgSubmitGroupProposal submits a new group proposal. + */ export class MsgSubmitGroupProposal extends JSONSerializable< MsgSubmitGroupProposal.Amino, MsgSubmitGroupProposal.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupAdmin.ts b/src/core/group/msgs/MsgUpdateGroupAdmin.ts index c1c2bda..1660a29 100644 --- a/src/core/group/msgs/MsgUpdateGroupAdmin.ts +++ b/src/core/group/msgs/MsgUpdateGroupAdmin.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateGroupAdmin as MsgUpdateGroupAdmin_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupAdmin updates the group admin with given group id and previous admin address. + */ export class MsgUpdateGroupAdmin extends JSONSerializable< MsgUpdateGroupAdmin.Amino, MsgUpdateGroupAdmin.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupDecisionPolicy.ts b/src/core/group/msgs/MsgUpdateGroupDecisionPolicy.ts index f8ea35e..8e72716 100644 --- a/src/core/group/msgs/MsgUpdateGroupDecisionPolicy.ts +++ b/src/core/group/msgs/MsgUpdateGroupDecisionPolicy.ts @@ -4,6 +4,9 @@ import { DecisionPolicy } from '../policies' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateGroupPolicyDecisionPolicy as MsgUpdateGroupPolicyDecisionPolicy_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupDecisionPolicy allows a group policy's decision policy to be updated. + */ export class MsgUpdateGroupDecisionPolicy extends JSONSerializable< MsgUpdateGroupDecisionPolicy.Amino, MsgUpdateGroupDecisionPolicy.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupMembers.ts b/src/core/group/msgs/MsgUpdateGroupMembers.ts index c214a26..58aa5c6 100644 --- a/src/core/group/msgs/MsgUpdateGroupMembers.ts +++ b/src/core/group/msgs/MsgUpdateGroupMembers.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MemberRequest } from '../GroupMember' import { MsgUpdateGroupMembers as MsgUpdateGroupMembers_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupMembers updates the group members with given group id and admin address. + */ export class MsgUpdateGroupMembers extends JSONSerializable< MsgUpdateGroupMembers.Amino, MsgUpdateGroupMembers.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupMetadata.ts b/src/core/group/msgs/MsgUpdateGroupMetadata.ts index 9b9c8c7..9abcc67 100644 --- a/src/core/group/msgs/MsgUpdateGroupMetadata.ts +++ b/src/core/group/msgs/MsgUpdateGroupMetadata.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateGroupMetadata as MsgUpdateGroupMetadata_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupMetadata updates the group metadata with given group id and admin address. + */ export class MsgUpdateGroupMetadata extends JSONSerializable< MsgUpdateGroupMetadata.Amino, MsgUpdateGroupMetadata.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupPolicyAdmin.ts b/src/core/group/msgs/MsgUpdateGroupPolicyAdmin.ts index cf3b0d4..84adf4a 100644 --- a/src/core/group/msgs/MsgUpdateGroupPolicyAdmin.ts +++ b/src/core/group/msgs/MsgUpdateGroupPolicyAdmin.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateGroupPolicyAdmin as MsgUpdateGroupPolicyAdmin_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupPolicyAdmin updates a group policy admin. + */ export class MsgUpdateGroupPolicyAdmin extends JSONSerializable< MsgUpdateGroupPolicyAdmin.Amino, MsgUpdateGroupPolicyAdmin.Data, diff --git a/src/core/group/msgs/MsgUpdateGroupPolicyMetadata.ts b/src/core/group/msgs/MsgUpdateGroupPolicyMetadata.ts index e3bca7b..b855b10 100644 --- a/src/core/group/msgs/MsgUpdateGroupPolicyMetadata.ts +++ b/src/core/group/msgs/MsgUpdateGroupPolicyMetadata.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateGroupPolicyMetadata as MsgUpdateGroupPolicyMetadata_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgUpdateGroupPolicyMetadata updates a group policy metadata. + */ export class MsgUpdateGroupPolicyMetadata extends JSONSerializable< MsgUpdateGroupPolicyMetadata.Amino, MsgUpdateGroupPolicyMetadata.Data, diff --git a/src/core/group/msgs/MsgWithdrawProposal.ts b/src/core/group/msgs/MsgWithdrawProposal.ts index a1f3f0e..6f9b10b 100644 --- a/src/core/group/msgs/MsgWithdrawProposal.ts +++ b/src/core/group/msgs/MsgWithdrawProposal.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgWithdrawProposal as MsgWithdrawProposal_pb } from '@initia/initia.proto/cosmos/group/v1/tx' +/** + * MsgWithdrawProposal withdraws a group proposal. + */ export class MsgWithdrawProposal extends JSONSerializable< MsgWithdrawProposal.Amino, MsgWithdrawProposal.Data, diff --git a/src/core/group/policies/DecisionPolicyWindows.ts b/src/core/group/policies/DecisionPolicyWindows.ts index b9f6b6c..8f1e962 100644 --- a/src/core/group/policies/DecisionPolicyWindows.ts +++ b/src/core/group/policies/DecisionPolicyWindows.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../../util/json' import { Duration } from '../../Duration' import { DecisionPolicyWindows as DecisionPolicyWindows_pb } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * DecisionPolicyWindows defines the different windows for voting and execution. + */ export class DecisionPolicyWindows extends JSONSerializable< DecisionPolicyWindows.Amino, DecisionPolicyWindows.Data, diff --git a/src/core/group/policies/PercentageDecisionPolicy.ts b/src/core/group/policies/PercentageDecisionPolicy.ts index aa587fa..441ee11 100644 --- a/src/core/group/policies/PercentageDecisionPolicy.ts +++ b/src/core/group/policies/PercentageDecisionPolicy.ts @@ -3,6 +3,14 @@ import { DecisionPolicyWindows } from './DecisionPolicyWindows' import { Any } from '@initia/initia.proto/google/protobuf/any' import { PercentageDecisionPolicy as PercentageDecisionPolicy_pb } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * PercentageDecisionPolicy is a decision policy where a proposal passes when + * it satisfies the two following conditions: + * 1. The percentage of all `YES` voters' weights out of the total group weight + * is greater or equal than the given `percentage`. + * 2. The voting and execution periods of the proposal respect the parameters + * given by `windows`. + */ export class PercentageDecisionPolicy extends JSONSerializable< PercentageDecisionPolicy.Amino, PercentageDecisionPolicy.Data, diff --git a/src/core/group/policies/ThresholdDecisionPolicy.ts b/src/core/group/policies/ThresholdDecisionPolicy.ts index 4c78931..8361a36 100644 --- a/src/core/group/policies/ThresholdDecisionPolicy.ts +++ b/src/core/group/policies/ThresholdDecisionPolicy.ts @@ -3,6 +3,12 @@ import { DecisionPolicyWindows } from './DecisionPolicyWindows' import { Any } from '@initia/initia.proto/google/protobuf/any' import { ThresholdDecisionPolicy as ThresholdDecisionPolicy_pb } from '@initia/initia.proto/cosmos/group/v1/types' +/** + * ThresholdDecisionPolicy is a decision policy where a proposal passes when it + * satisfies the two following conditions: + * 1. The sum of all `YES` voter's weights is greater or equal than the defined `threshold`. + * 2. The voting and execution periods of the proposal respect the parameters given by `windows`. + */ export class ThresholdDecisionPolicy extends JSONSerializable< ThresholdDecisionPolicy.Amino, ThresholdDecisionPolicy.Data, diff --git a/src/core/ibc/applications/fee/IbcFee.ts b/src/core/ibc/applications/fee/IbcFee.ts index 040cfde..3d50edd 100644 --- a/src/core/ibc/applications/fee/IbcFee.ts +++ b/src/core/ibc/applications/fee/IbcFee.ts @@ -3,7 +3,7 @@ import { Coins } from '../../../Coins' import { JSONSerializable } from '../../../../util/json' /** - * Fee defines the ICS29 receive, acknowledgement and timeout fees + * Fee defines the ICS29 receive, acknowledgement and timeout fees */ export class IbcFee extends JSONSerializable< IbcFee.Amino, diff --git a/src/core/ibc/applications/fee/IdentifiedPacketFee.ts b/src/core/ibc/applications/fee/IdentifiedPacketFee.ts index 24118bf..a9b9937 100644 --- a/src/core/ibc/applications/fee/IdentifiedPacketFee.ts +++ b/src/core/ibc/applications/fee/IdentifiedPacketFee.ts @@ -4,7 +4,7 @@ import { PacketFee } from './PacketFee' import { PacketId } from '../../core/channel/PacketId' /** - * IdentifiedPacketFees contains a list of type PacketFee and associated PacketId + * IdentifiedPacketFees contains a list of type PacketFee and associated PacketId */ export class IdentifiedPacketFees extends JSONSerializable< IdentifiedPacketFees.Amino, diff --git a/src/core/ibc/applications/fee/PacketFee.ts b/src/core/ibc/applications/fee/PacketFee.ts index 30c8c98..6bda24f 100644 --- a/src/core/ibc/applications/fee/PacketFee.ts +++ b/src/core/ibc/applications/fee/PacketFee.ts @@ -4,7 +4,7 @@ import { IbcFee } from './IbcFee' import { AccAddress } from '../../../..' /** - * PacketFee contains ICS29 relayer fees, refund address and optional list of permitted relayers + * PacketFee contains ICS29 relayer fees, refund address and optional list of permitted relayers */ export class PacketFee extends JSONSerializable< PacketFee.Amino, diff --git a/src/core/ibc/applications/interchain-account/controller/Params.ts b/src/core/ibc/applications/interchain-account/controller/Params.ts index 79d38e5..f929632 100644 --- a/src/core/ibc/applications/interchain-account/controller/Params.ts +++ b/src/core/ibc/applications/interchain-account/controller/Params.ts @@ -2,8 +2,8 @@ import { Params as Params_pb } from '@initia/initia.proto/ibc/applications/inter import { JSONSerializable } from '../../../../../util/json' /** - * Params defines the set of on-chain interchain accounts parameters. - * The following parameters may be used to disable the controller submodule. + * Params defines the set of on-chain interchain accounts parameters. + * The following parameters may be used to disable the controller submodule. */ export class Params extends JSONSerializable< Params.Amino, diff --git a/src/core/ibc/applications/interchain-account/host/Params.ts b/src/core/ibc/applications/interchain-account/host/Params.ts index c61d261..7883fbf 100644 --- a/src/core/ibc/applications/interchain-account/host/Params.ts +++ b/src/core/ibc/applications/interchain-account/host/Params.ts @@ -2,8 +2,8 @@ import { Params as Params_pb } from '@initia/initia.proto/ibc/applications/inter import { JSONSerializable } from '../../../../../util/json' /** - * Params defines the set of on-chain interchain accounts parameters. - * The following parameters may be used to disable the host submodule. + * Params defines the set of on-chain interchain accounts parameters. + * The following parameters may be used to disable the host submodule. */ export class Params extends JSONSerializable< Params.Amino, diff --git a/src/core/ibc/applications/nft-transfer/IbcNftParams.ts b/src/core/ibc/applications/nft-transfer/IbcNftParams.ts index adaa82d..7873fe5 100644 --- a/src/core/ibc/applications/nft-transfer/IbcNftParams.ts +++ b/src/core/ibc/applications/nft-transfer/IbcNftParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../../../util/json' import { Params as Params_pb } from '@initia/initia.proto/ibc/applications/nft_transfer/v1/types' +/** + * IbcNftParams defines the set of ibc nft parameters. + */ export class IbcNftParams extends JSONSerializable< IbcNftParams.Amino, IbcNftParams.Data, diff --git a/src/core/ibc/applications/nft-transfer/NonFungibleTokenPacketData.ts b/src/core/ibc/applications/nft-transfer/NonFungibleTokenPacketData.ts index 7ed6b6d..9794848 100644 --- a/src/core/ibc/applications/nft-transfer/NonFungibleTokenPacketData.ts +++ b/src/core/ibc/applications/nft-transfer/NonFungibleTokenPacketData.ts @@ -2,7 +2,7 @@ import { NonFungibleTokenPacketData as NonFungibleTokenPacketData_pb } from '@in import { JSONSerializable } from '../../../../util/json' /** - * NonFungibleTokenPacketData defines a struct for the packet payload + * NonFungibleTokenPacketData defines a struct for the packet payload * See NonFungibleTokenPacketData spec: * https://github.com/cosmos/ibc/tree/main/spec/app/ics-721-nft-transfer */ diff --git a/src/core/ibc/applications/nft-transfer/msgs/MsgUpdateIbcNftParams.ts b/src/core/ibc/applications/nft-transfer/msgs/MsgUpdateIbcNftParams.ts index 864d55a..1f21945 100644 --- a/src/core/ibc/applications/nft-transfer/msgs/MsgUpdateIbcNftParams.ts +++ b/src/core/ibc/applications/nft-transfer/msgs/MsgUpdateIbcNftParams.ts @@ -4,6 +4,9 @@ import { IbcNftParams } from '../IbcNftParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/ibc/applications/nft_transfer/v1/tx' +/** + * MsgUpdateIbcNftParams defines an operation for updating the ibc nft module parameters. + */ export class MsgUpdateIbcNftParams extends JSONSerializable< MsgUpdateIbcNftParams.Amino, MsgUpdateIbcNftParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateIbcNftParams extends JSONSerializable< > { /** * @param authority the address that controls the module - * @param params the parameters to update + * @param params the ibc nft parameters to update */ constructor( public authority: AccAddress, diff --git a/src/core/ibc/applications/transfer/FungibleTokenPacketData.ts b/src/core/ibc/applications/transfer/FungibleTokenPacketData.ts index 69dc752..a362ed6 100644 --- a/src/core/ibc/applications/transfer/FungibleTokenPacketData.ts +++ b/src/core/ibc/applications/transfer/FungibleTokenPacketData.ts @@ -2,7 +2,7 @@ import { FungibleTokenPacketData as FungibleTokenPacketData_pb } from '@initia/i import { JSONSerializable } from '../../../../util/json' /** - * FungibleTokenPacketData defines a struct for the packet payload + * FungibleTokenPacketData defines a struct for the packet payload * See FungibleTokenPacketData spec: * https://github.com/cosmos/ibc/tree/master/spec/app/ics-020-fungible-token-transfer#data-structures */ diff --git a/src/core/ibc/applications/transfer/IbcTransferParams.ts b/src/core/ibc/applications/transfer/IbcTransferParams.ts index c7ddae8..d3f9007 100644 --- a/src/core/ibc/applications/transfer/IbcTransferParams.ts +++ b/src/core/ibc/applications/transfer/IbcTransferParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../../../util/json' import { Params as Params_pb } from '@initia/initia.proto/ibc/applications/transfer/v1/transfer' +/** + * IbcTransferParams defines the set of ibc transfer parameters. + */ export class IbcTransferParams extends JSONSerializable< IbcTransferParams.Amino, IbcTransferParams.Data, diff --git a/src/core/ibc/applications/transfer/msgs/MsgUpdateIbcTransferParams.ts b/src/core/ibc/applications/transfer/msgs/MsgUpdateIbcTransferParams.ts index 776ad15..4e60d5f 100644 --- a/src/core/ibc/applications/transfer/msgs/MsgUpdateIbcTransferParams.ts +++ b/src/core/ibc/applications/transfer/msgs/MsgUpdateIbcTransferParams.ts @@ -4,6 +4,9 @@ import { IbcTransferParams } from '../IbcTransferParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/ibc/applications/transfer/v1/tx' +/** + * MsgUpdateIbcTransferParams defines an operation for updating the ibc transfer module parameters. + */ export class MsgUpdateIbcTransferParams extends JSONSerializable< any, MsgUpdateIbcTransferParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateIbcTransferParams extends JSONSerializable< > { /** * @param signer the address that controls the module - * @param params the parameters to update + * @param params the ibc transfer parameters to update */ constructor( public signer: AccAddress, diff --git a/src/core/ibc/core/channel/IbcChannelParams.ts b/src/core/ibc/core/channel/IbcChannelParams.ts index 178c591..924b447 100644 --- a/src/core/ibc/core/channel/IbcChannelParams.ts +++ b/src/core/ibc/core/channel/IbcChannelParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../../../util/json' import { Params as Params_pb } from '@initia/initia.proto/ibc/core/channel/v1/channel' import { Timeout } from './Timeout' +/** + * IbcChannelParams defines the set of ibc channel parameters. + */ export class IbcChannelParams extends JSONSerializable< IbcChannelParams.Amino, IbcChannelParams.Data, diff --git a/src/core/ibc/core/channel/msgs/MsgChannelOpenConfirm.ts b/src/core/ibc/core/channel/msgs/MsgChannelOpenConfirm.ts index d703b68..af73781 100644 --- a/src/core/ibc/core/channel/msgs/MsgChannelOpenConfirm.ts +++ b/src/core/ibc/core/channel/msgs/MsgChannelOpenConfirm.ts @@ -5,7 +5,7 @@ import { MsgChannelOpenConfirm as MsgChannelOpenConfirm_pb } from '@initia/initi import { Height } from '../../client' /** - * MsgChannelOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to OPEN on Chain A. + * MsgChannelOpenConfirm defines a msg sent by a Relayer to Chain B to acknowledge the change of channel state to OPEN on Chain A. */ export class MsgChannelOpenConfirm extends JSONSerializable< any, diff --git a/src/core/ibc/core/channel/msgs/MsgUpdateIbcChannelParams.ts b/src/core/ibc/core/channel/msgs/MsgUpdateIbcChannelParams.ts index 9b52cd6..040b4b6 100644 --- a/src/core/ibc/core/channel/msgs/MsgUpdateIbcChannelParams.ts +++ b/src/core/ibc/core/channel/msgs/MsgUpdateIbcChannelParams.ts @@ -4,6 +4,9 @@ import { IbcChannelParams } from '../IbcChannelParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/ibc/core/channel/v1/tx' +/** + * MsgUpdateIbcChannelParams defines an operation for updating the ibc channel module parameters. + */ export class MsgUpdateIbcChannelParams extends JSONSerializable< any, MsgUpdateIbcChannelParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateIbcChannelParams extends JSONSerializable< > { /** * @param authority the address that controls the module - * @param params the channel parameters to update + * @param params the ibc channel parameters to update */ constructor( public authority: AccAddress, diff --git a/src/core/ibc/core/client/IbcClientParams.ts b/src/core/ibc/core/client/IbcClientParams.ts index aabcb62..c8600b0 100644 --- a/src/core/ibc/core/client/IbcClientParams.ts +++ b/src/core/ibc/core/client/IbcClientParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../../../util/json' import { Params as Params_pb } from '@initia/initia.proto/ibc/core/client/v1/client' +/** + * IbcClientParams defines the set of ibc client parameters. + */ export class IbcClientParams extends JSONSerializable< IbcClientParams.Amino, IbcClientParams.Data, diff --git a/src/core/ibc/core/client/msgs/MsgSubmitMisbehaviour.ts b/src/core/ibc/core/client/msgs/MsgSubmitMisbehaviour.ts index 3081b0c..27b8fe2 100644 --- a/src/core/ibc/core/client/msgs/MsgSubmitMisbehaviour.ts +++ b/src/core/ibc/core/client/msgs/MsgSubmitMisbehaviour.ts @@ -4,7 +4,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgSubmitMisbehaviour as MsgSubmitMisbehaviour_pb } from '@initia/initia.proto/ibc/core/client/v1/tx' /** - * MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for light client misbehaviour. + * MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for light client misbehaviour. */ export class MsgSubmitMisbehaviour extends JSONSerializable< any, diff --git a/src/core/ibc/core/client/msgs/MsgUpdateIbcClientParams.ts b/src/core/ibc/core/client/msgs/MsgUpdateIbcClientParams.ts index adf3552..5170c63 100644 --- a/src/core/ibc/core/client/msgs/MsgUpdateIbcClientParams.ts +++ b/src/core/ibc/core/client/msgs/MsgUpdateIbcClientParams.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/ibc/core/client/v1/tx' import { IbcClientParams } from '../IbcClientParams' +/** + * MsgUpdateIbcClientParams defines an operation for updating the ibc client module parameters. + */ export class MsgUpdateIbcClientParams extends JSONSerializable< any, MsgUpdateIbcClientParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateIbcClientParams extends JSONSerializable< > { /** * @param signer signer address - * @param params the client parameters to update + * @param params the ibc client parameters to update */ constructor( public signer: AccAddress, diff --git a/src/core/ibc/core/connection/IbcConnectionParams.ts b/src/core/ibc/core/connection/IbcConnectionParams.ts index e0a59f3..89631d6 100644 --- a/src/core/ibc/core/connection/IbcConnectionParams.ts +++ b/src/core/ibc/core/connection/IbcConnectionParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../../../util/json' import { Params as Params_pb } from '@initia/initia.proto/ibc/core/connection/v1/connection' +/** + * IbcConnectionParams defines the set of ibc connection parameters. + */ export class IbcConnectionParams extends JSONSerializable< IbcConnectionParams.Amino, IbcConnectionParams.Data, diff --git a/src/core/ibc/core/connection/msgs/MsgConnectionOpenTry.ts b/src/core/ibc/core/connection/msgs/MsgConnectionOpenTry.ts index abeff9b..1434b6b 100644 --- a/src/core/ibc/core/connection/msgs/MsgConnectionOpenTry.ts +++ b/src/core/ibc/core/connection/msgs/MsgConnectionOpenTry.ts @@ -7,7 +7,7 @@ import { IbcVersion } from '../IbcVersion' import { Height } from '../../client' /** - * MsgConnectionOpenTry defines a msg sent by a Relayer to try to open a connection on Chain B. + * MsgConnectionOpenTry defines a msg sent by a Relayer to try to open a connection on Chain B. */ export class MsgConnectionOpenTry extends JSONSerializable< any, diff --git a/src/core/ibc/core/connection/msgs/MsgUpdateIbcConnectionParams.ts b/src/core/ibc/core/connection/msgs/MsgUpdateIbcConnectionParams.ts index 3ce12c6..836f558 100644 --- a/src/core/ibc/core/connection/msgs/MsgUpdateIbcConnectionParams.ts +++ b/src/core/ibc/core/connection/msgs/MsgUpdateIbcConnectionParams.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/ibc/core/connection/v1/tx' import { IbcConnectionParams } from '../IbcConnectionParams' +/** + * MsgUpdateIbcConnectionParams defines an operation for updating the ibc connection module parameters. + */ export class MsgUpdateIbcConnectionParams extends JSONSerializable< any, MsgUpdateIbcConnectionParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateIbcConnectionParams extends JSONSerializable< > { /** * @param signer signer address - * @param params the connection parameters to update + * @param params the ibc connection parameters to update */ constructor( public signer: AccAddress, diff --git a/src/core/ibchooks/ACL.ts b/src/core/ibchooks/ACL.ts index 868ff0a..6ccd604 100644 --- a/src/core/ibchooks/ACL.ts +++ b/src/core/ibchooks/ACL.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { AccAddress } from '../bech32' import { ACL as ACL_pb } from '@initia/initia.proto/initia/ibchooks/v1/types' +/** + * ACL defines the ACL entry of an address. + */ export class ACL extends JSONSerializable { /** * @param address diff --git a/src/core/ibchooks/IbcHooksParams.ts b/src/core/ibchooks/IbcHooksParams.ts index f279ba7..057dd52 100644 --- a/src/core/ibchooks/IbcHooksParams.ts +++ b/src/core/ibchooks/IbcHooksParams.ts @@ -1,6 +1,9 @@ import { JSONSerializable } from '../../util/json' import { Params as Params_pb } from '@initia/initia.proto/initia/ibchooks/v1/types' +/** + * IbcHooksParams defines the set of ibc hooks parameters. + */ export class IbcHooksParams extends JSONSerializable< IbcHooksParams.Amino, IbcHooksParams.Data, diff --git a/src/core/ibchooks/msgs/MsgUpdateACL.ts b/src/core/ibchooks/msgs/MsgUpdateACL.ts index aad857f..b936cb2 100644 --- a/src/core/ibchooks/msgs/MsgUpdateACL.ts +++ b/src/core/ibchooks/msgs/MsgUpdateACL.ts @@ -3,6 +3,9 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateACL as MsgUpdateACL_pb } from '@initia/initia.proto/initia/ibchooks/v1/tx' +/** + * MsgUpdateACL is the message to update ACL of an address. + */ export class MsgUpdateACL extends JSONSerializable< MsgUpdateACL.Amino, MsgUpdateACL.Data, diff --git a/src/core/ibchooks/msgs/MsgUpdateIbcHooksParams.ts b/src/core/ibchooks/msgs/MsgUpdateIbcHooksParams.ts index 36b7b4a..0460552 100644 --- a/src/core/ibchooks/msgs/MsgUpdateIbcHooksParams.ts +++ b/src/core/ibchooks/msgs/MsgUpdateIbcHooksParams.ts @@ -4,6 +4,9 @@ import { IbcHooksParams } from '../IbcHooksParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/initia/ibchooks/v1/tx' +/** + * MsgUpdateIbcHooksParams defines an operation for updating the ibc hooks module parameters. + */ export class MsgUpdateIbcHooksParams extends JSONSerializable< MsgUpdateIbcHooksParams.Amino, MsgUpdateIbcHooksParams.Data, diff --git a/src/core/marketmap/Market.ts b/src/core/marketmap/Market.ts index cff7330..ba3cb55 100644 --- a/src/core/marketmap/Market.ts +++ b/src/core/marketmap/Market.ts @@ -3,6 +3,9 @@ import { ProviderConfig } from './ProviderConfig' import { Ticker } from './Ticker' import { Market as Market_pb } from '@initia/initia.proto/connect/marketmap/v2/market' +/** + * Market encapsulates a Ticker and its provider-specific configuration. + */ export class Market extends JSONSerializable< Market.Amino, Market.Data, diff --git a/src/core/marketmap/MarketmapParams.ts b/src/core/marketmap/MarketmapParams.ts index cc89ffd..947cd8d 100644 --- a/src/core/marketmap/MarketmapParams.ts +++ b/src/core/marketmap/MarketmapParams.ts @@ -2,6 +2,9 @@ import { AccAddress } from '../bech32' import { JSONSerializable } from '../../util/json' import { Params as Params_pb } from '@initia/initia.proto/connect/marketmap/v2/params' +/** + * MarketmapParams defines the set of marketmap parameters. + */ export class MarketmapParams extends JSONSerializable< MarketmapParams.Amino, MarketmapParams.Data, diff --git a/src/core/marketmap/Ticker.ts b/src/core/marketmap/Ticker.ts index b4e1b73..7f51715 100644 --- a/src/core/marketmap/Ticker.ts +++ b/src/core/marketmap/Ticker.ts @@ -2,6 +2,11 @@ import { JSONSerializable } from '../../util/json' import { CurrencyPair } from '../oracle' import { Ticker as Ticker_pb } from '@initia/initia.proto/connect/marketmap/v2/market' +/** + * Ticker represents a price feed for a given asset pair i.e. BTC/USD. The price + * feed is scaled to a number of decimal places and has a minimum number of + * providers required to consider the ticker valid. + */ export class Ticker extends JSONSerializable< Ticker.Amino, Ticker.Data, diff --git a/src/core/marketmap/msgs/MsgCreateMarkets.ts b/src/core/marketmap/msgs/MsgCreateMarkets.ts index f6b689a..f7386e0 100644 --- a/src/core/marketmap/msgs/MsgCreateMarkets.ts +++ b/src/core/marketmap/msgs/MsgCreateMarkets.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgCreateMarkets as MsgCreateMarkets_pb } from '@initia/initia.proto/connect/marketmap/v2/tx' import { Market } from '../Market' +/** + * MsgCreateMarkets creates markets from the given message. + */ export class MsgCreateMarkets extends JSONSerializable< MsgCreateMarkets.Amino, MsgCreateMarkets.Data, diff --git a/src/core/marketmap/msgs/MsgRemoveMarketAuthorities.ts b/src/core/marketmap/msgs/MsgRemoveMarketAuthorities.ts index 42049a1..0dd1b51 100644 --- a/src/core/marketmap/msgs/MsgRemoveMarketAuthorities.ts +++ b/src/core/marketmap/msgs/MsgRemoveMarketAuthorities.ts @@ -3,6 +3,10 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgRemoveMarketAuthorities as MsgRemoveMarketAuthorities_pb } from '@initia/initia.proto/connect/marketmap/v2/tx' +/** + * MsgRemoveMarketAuthorities defines a method for removing market authorities + * from the marketmap module. The signer must be the admin. + */ export class MsgRemoveMarketAuthorities extends JSONSerializable< MsgRemoveMarketAuthorities.Amino, MsgRemoveMarketAuthorities.Data, diff --git a/src/core/marketmap/msgs/MsgUpdateMarketmapParams.ts b/src/core/marketmap/msgs/MsgUpdateMarketmapParams.ts index 68be564..7a3d80d 100644 --- a/src/core/marketmap/msgs/MsgUpdateMarketmapParams.ts +++ b/src/core/marketmap/msgs/MsgUpdateMarketmapParams.ts @@ -4,6 +4,9 @@ import { MarketmapParams } from '../MarketmapParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgParams as MsgParams_pb } from '@initia/initia.proto/connect/marketmap/v2/tx' +/** + * MsgUpdateMarketmapParams defines an operation for updating the marketmap module parameters. + */ export class MsgUpdateMarketmapParams extends JSONSerializable< MsgUpdateMarketmapParams.Amino, MsgUpdateMarketmapParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateMarketmapParams extends JSONSerializable< > { /** * @param authority the address that controls the module - * @param params the hook parameters to update + * @param params the marketmap parameters to update */ constructor( public authority: AccAddress, diff --git a/src/core/marketmap/msgs/MsgUpdateMarkets.ts b/src/core/marketmap/msgs/MsgUpdateMarkets.ts index 6da36d8..8bea539 100644 --- a/src/core/marketmap/msgs/MsgUpdateMarkets.ts +++ b/src/core/marketmap/msgs/MsgUpdateMarkets.ts @@ -4,6 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateMarkets as MsgUpdateMarkets_pb } from '@initia/initia.proto/connect/marketmap/v2/tx' import { Market } from '../Market' +/** + * MsgUpdateMarkets updates markets from the given message. + */ export class MsgUpdateMarkets extends JSONSerializable< MsgUpdateMarkets.Amino, MsgUpdateMarkets.Data, diff --git a/src/core/marketmap/msgs/MsgUpsertMarkets.ts b/src/core/marketmap/msgs/MsgUpsertMarkets.ts index 187f7de..ffe514e 100644 --- a/src/core/marketmap/msgs/MsgUpsertMarkets.ts +++ b/src/core/marketmap/msgs/MsgUpsertMarkets.ts @@ -4,6 +4,11 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpsertMarkets as MsgUpsertMarkets_pb } from '@initia/initia.proto/connect/marketmap/v2/tx' import { Market } from '../Market' +/** + * MsgUpsertMarkets wraps both Create / Update markets into a single message. + * Specifically if a market does not exist it will be created, otherwise it + * will be updated. The response will be a map between ticker -> updated. + */ export class MsgUpsertMarkets extends JSONSerializable< MsgUpsertMarkets.Amino, MsgUpsertMarkets.Data, diff --git a/src/core/mstaking/Delegation.ts b/src/core/mstaking/Delegation.ts index c356206..fc02666 100644 --- a/src/core/mstaking/Delegation.ts +++ b/src/core/mstaking/Delegation.ts @@ -7,7 +7,7 @@ import { } from '@initia/initia.proto/initia/mstaking/v1/staking' /** - * Stores information about the status of a delegation between a delegator and validator, fetched from the blockchain. + * Delegation stores information about the status of a delegation between a delegator and validator, fetched from the blockchain. */ export class Delegation extends JSONSerializable< Delegation.Amino, diff --git a/src/core/mstaking/MstakingParams.ts b/src/core/mstaking/MstakingParams.ts index fd6492d..0c75a38 100644 --- a/src/core/mstaking/MstakingParams.ts +++ b/src/core/mstaking/MstakingParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Duration } from '../Duration' import { Params as Params_pb } from '@initia/initia.proto/initia/mstaking/v1/staking' +/** + * MstakingParams defines the set of mstaking parameters. + */ export class MstakingParams extends JSONSerializable< MstakingParams.Amino, MstakingParams.Data, diff --git a/src/core/mstaking/Redelegation.ts b/src/core/mstaking/Redelegation.ts index b74fcbc..0549772 100644 --- a/src/core/mstaking/Redelegation.ts +++ b/src/core/mstaking/Redelegation.ts @@ -9,16 +9,8 @@ import { } from '@initia/initia.proto/initia/mstaking/v1/staking' /** - * A redelegation is when a delegator decides to stop mstaking with one validator and - * transfer their delegation to another validator. Rather than unbonding (which takes - * some time) and re-staking, the funds can be redelegated immediately if a - * [[Redelegation.Entry]] can be created. - * - * A redelegation, like an unbonding delegation, is implemented through - * [[Redelegation.Entry]] objects, limited by the `max_entry` parameter in the mstaking - * module params. For each pair of source and target validators, you cannot redelegate - * more times than the amount of entries. Entries are cleared when the redelegation is - * completed, the same amount of time as unbonding. + * Redelegation contains the list of a particular delegator's redelegating bonds + * from a particular source validator to a particular destination validator. */ export class Redelegation extends JSONSerializable< Redelegation.Amino, @@ -26,7 +18,6 @@ export class Redelegation extends JSONSerializable< Redelegation.Proto > { /** - * * @param delegator_address delegator's account address * @param validator_src_address source validator's operator address (from) * @param validator_dst_address target validator's operator address (to) @@ -172,7 +163,6 @@ export namespace Redelegation { public balance: Coins /** - * * @param initial_balance balance of delegation prior to initiating redelegation * @param shares_dst * @param creation_height height of blockchain when entry was created diff --git a/src/core/mstaking/UnbondingDelegation.ts b/src/core/mstaking/UnbondingDelegation.ts index 763e492..100195d 100644 --- a/src/core/mstaking/UnbondingDelegation.ts +++ b/src/core/mstaking/UnbondingDelegation.ts @@ -7,15 +7,8 @@ import { } from '@initia/initia.proto/initia/mstaking/v1/staking' /** - * When a delegator decides to take out their funds from the mstaking pool, they must - * unbond their tokens which takes an amount of time specified by `unbonding_time` - * parameter in the mstaking module. - * - * An unbonding delegation is implemented through creating [[UnbondingDelegation.Entry]] - * objects, limited by the max_entry parameter in the mstaking module params. You cannot - * initiate unbonds more times than the amount of entries permitted. Entries are cleared - * when their unbonding periods are completed and the funds are returned to the - * delegator's account balance to be spent freely. + * UnbondingDelegation stores all of a single delegator's unbonding bonds + * for a single validator in an time-ordered list. */ export class UnbondingDelegation extends JSONSerializable< UnbondingDelegation.Amino, diff --git a/src/core/mstaking/Validator.ts b/src/core/mstaking/Validator.ts index 99cf6b4..651b33c 100644 --- a/src/core/mstaking/Validator.ts +++ b/src/core/mstaking/Validator.ts @@ -12,7 +12,7 @@ import { import { Any } from '@initia/initia.proto/google/protobuf/any' /** - * Stores information fetched from the blockchain about the current status of a validator. + * Validator stores information fetched from the blockchain about the current status of a validator. * As an end user, you will not have to create an instance of this class, one will be * generated for you to store information about a validator polled from the API functions * in [[MstakingAPI]]. @@ -27,7 +27,6 @@ export class Validator extends JSONSerializable< public voting_powers: Coins /** - * * @param operator_address validator's operator address * @param consensus_pubkey validator's consensus public key * @param jailed whether the current validator is jailed diff --git a/src/core/mstaking/msgs/MsgBeginRedelegate.ts b/src/core/mstaking/msgs/MsgBeginRedelegate.ts index e94ec57..a135df2 100644 --- a/src/core/mstaking/msgs/MsgBeginRedelegate.ts +++ b/src/core/mstaking/msgs/MsgBeginRedelegate.ts @@ -5,9 +5,8 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgBeginRedelegate as MsgBeginRedelegate_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' /** - * A delegator can choose to redelegate their bonded Initia and transfer a delegation - * amount from one validator to another. Unlike undelegating, redelegations do not incur - * a 21-day unbonding period and happen immediately. + * MsgBeginRedelegate defines a method for performing a redelegation + * of coins from a delegator and source validator to a destination validator. */ export class MsgBeginRedelegate extends JSONSerializable< MsgBeginRedelegate.Amino, @@ -17,7 +16,6 @@ export class MsgBeginRedelegate extends JSONSerializable< public amount: Coins /** - * * @param delegator_address delegator's account address * @param validator_src_address validator to undelegate from * @param validator_dst_address validator to delegate to diff --git a/src/core/mstaking/msgs/MsgCancelUnbondingDelegation.ts b/src/core/mstaking/msgs/MsgCancelUnbondingDelegation.ts index 312a140..f0b1463 100644 --- a/src/core/mstaking/msgs/MsgCancelUnbondingDelegation.ts +++ b/src/core/mstaking/msgs/MsgCancelUnbondingDelegation.ts @@ -4,6 +4,10 @@ import { AccAddress, ValAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgCancelUnbondingDelegation as MsgCancelUnbondingDelegation_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' +/** + * MsgCancelUnbondingDelegation defines a method for performing canceling the unbonding delegation + * and delegate back to previous validator. + */ export class MsgCancelUnbondingDelegation extends JSONSerializable< MsgCancelUnbondingDelegation.Amino, MsgCancelUnbondingDelegation.Data, diff --git a/src/core/mstaking/msgs/MsgCreateValidator.ts b/src/core/mstaking/msgs/MsgCreateValidator.ts index ce71747..b8d11da 100644 --- a/src/core/mstaking/msgs/MsgCreateValidator.ts +++ b/src/core/mstaking/msgs/MsgCreateValidator.ts @@ -7,8 +7,7 @@ import { MsgCreateValidator as MsgCreateValidator_pb } from '@initia/initia.prot import { ValConsPublicKey, PublicKey } from '../../PublicKey' /** - * For new validators, this message registers a validator address to be a delegate on - * the blockchain. + * MsgCreateValidator defines a method for creating a new validator. */ export class MsgCreateValidator extends JSONSerializable< MsgCreateValidator.Amino, @@ -18,7 +17,6 @@ export class MsgCreateValidator extends JSONSerializable< public amount: Coins /** - * * @param description validator's delegate information * @param commission validator's commission policy * @param validator_address validator's operator address diff --git a/src/core/mstaking/msgs/MsgDelegate.ts b/src/core/mstaking/msgs/MsgDelegate.ts index bd6b960..0780175 100644 --- a/src/core/mstaking/msgs/MsgDelegate.ts +++ b/src/core/mstaking/msgs/MsgDelegate.ts @@ -5,8 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgDelegate as MsgDelegate_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' /** - * A delegator can submit this message to send more Initia to be staked through a - * validator delegate. + * MsgDelegate defines a method for performing a delegation of coins from a delegator to a validator. */ export class MsgDelegate extends JSONSerializable< MsgDelegate.Amino, @@ -16,7 +15,6 @@ export class MsgDelegate extends JSONSerializable< public amount: Coins /** - * * @param delegator_address delegator's account address * @param validator_address validator's operator address * @param amount amount of INIT to be sent for delegation diff --git a/src/core/mstaking/msgs/MsgEditValidator.ts b/src/core/mstaking/msgs/MsgEditValidator.ts index 42eb435..c2f7593 100644 --- a/src/core/mstaking/msgs/MsgEditValidator.ts +++ b/src/core/mstaking/msgs/MsgEditValidator.ts @@ -5,12 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgEditValidator as MsgEditValidator_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' /** - * A validator can edit its delegate information, such as moniker, website, commission - * rate, etc. - * - * You must use special or sentinel values to inform that you want to leave the current - * field untouched. For `Description`,` you should start with [[MsgEditValidator.DESC_DO_NOT_MODIFY]] and - * change each field you wish to modify individually. + * MsgEditValidator defines a method for editing an existing validator. */ export class MsgEditValidator extends JSONSerializable< MsgEditValidator.Amino, diff --git a/src/core/mstaking/msgs/MsgUndelegate.ts b/src/core/mstaking/msgs/MsgUndelegate.ts index bc13711..1015ce9 100644 --- a/src/core/mstaking/msgs/MsgUndelegate.ts +++ b/src/core/mstaking/msgs/MsgUndelegate.ts @@ -5,9 +5,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUndelegate as MsgUndelegate_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' /** - * A delegator can undelegate an amount of bonded Initia, and will begin the unbonding - * process for those funds. The unbonding process takes 21 days to complete, during - * which the Initia cannot be transacted or swapped. + * MsgUndelegate defines a method for performing an undelegation from a delegate and a validator. */ export class MsgUndelegate extends JSONSerializable< MsgUndelegate.Amino, diff --git a/src/core/mstaking/msgs/MsgUpdateMstakingParams.ts b/src/core/mstaking/msgs/MsgUpdateMstakingParams.ts index 8079549..8abfae9 100644 --- a/src/core/mstaking/msgs/MsgUpdateMstakingParams.ts +++ b/src/core/mstaking/msgs/MsgUpdateMstakingParams.ts @@ -4,6 +4,9 @@ import { MstakingParams } from '../MstakingParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/initia/mstaking/v1/tx' +/** + * MsgUpdateMstakingParams defines an operation for updating the mstaking module parameters. + */ export class MsgUpdateMstakingParams extends JSONSerializable< MsgUpdateMstakingParams.Amino, MsgUpdateMstakingParams.Data, diff --git a/src/core/ophost/msgs/MsgUpdateOphostParams.ts b/src/core/ophost/msgs/MsgUpdateOphostParams.ts index dea4b6b..6709fed 100644 --- a/src/core/ophost/msgs/MsgUpdateOphostParams.ts +++ b/src/core/ophost/msgs/MsgUpdateOphostParams.ts @@ -14,7 +14,7 @@ export class MsgUpdateOphostParams extends JSONSerializable< > { /** * @param authority the address that controls the module - * @param params the move parameters to update + * @param params the ophost parameters to update */ constructor( public authority: AccAddress, diff --git a/src/core/oracle/CurrencyPair.ts b/src/core/oracle/CurrencyPair.ts index 0f307fe..173053a 100644 --- a/src/core/oracle/CurrencyPair.ts +++ b/src/core/oracle/CurrencyPair.ts @@ -1,6 +1,10 @@ import { JSONSerializable } from '../../util/json' import { CurrencyPair as CurrencyPair_pb } from '@initia/initia.proto/connect/types/v2/currency_pair' +/** + * CurrencyPair is the standard representation of a pair of assets, where one + * (Base) is priced in terms of the other (Quote). + */ export class CurrencyPair extends JSONSerializable< CurrencyPair.Amino, CurrencyPair.Data, diff --git a/src/core/oracle/QuotePrice.ts b/src/core/oracle/QuotePrice.ts index d554a72..926d007 100644 --- a/src/core/oracle/QuotePrice.ts +++ b/src/core/oracle/QuotePrice.ts @@ -1,6 +1,10 @@ import { JSONSerializable } from '../../util/json' import { QuotePrice as QuotePrice_pb } from '@initia/initia.proto/connect/oracle/v2/genesis' +/** + * QuotePrice is the representation of the aggregated prices for a CurrencyPair, + * where price represents the price of Base in terms of Quote. + */ export class QuotePrice extends JSONSerializable< QuotePrice.Amino, QuotePrice.Data, diff --git a/src/core/oracle/msgs/MsgAddCurrencyPairs.ts b/src/core/oracle/msgs/MsgAddCurrencyPairs.ts index 22ac1f4..fbc4825 100644 --- a/src/core/oracle/msgs/MsgAddCurrencyPairs.ts +++ b/src/core/oracle/msgs/MsgAddCurrencyPairs.ts @@ -4,6 +4,11 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgAddCurrencyPairs as MsgAddCurrencyPairs_pb } from '@initia/initia.proto/connect/oracle/v2/tx' import { CurrencyPair } from '../CurrencyPair' +/** + * MsgAddCurrencyPairs will be used only by governance to update the set of + * available CurrencyPairs. Given a set of CurrencyPair objects, update + * the available currency pairs in the module. + */ export class MsgAddCurrencyPairs extends JSONSerializable< MsgAddCurrencyPairs.Amino, MsgAddCurrencyPairs.Data, diff --git a/src/core/oracle/msgs/MsgRemoveCurrencyPairs.ts b/src/core/oracle/msgs/MsgRemoveCurrencyPairs.ts index 34d41dc..ba28444 100644 --- a/src/core/oracle/msgs/MsgRemoveCurrencyPairs.ts +++ b/src/core/oracle/msgs/MsgRemoveCurrencyPairs.ts @@ -3,6 +3,11 @@ import { AccAddress } from '../../bech32' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgRemoveCurrencyPairs as MsgRemoveCurrencyPairs_pb } from '@initia/initia.proto/connect/oracle/v2/tx' +/** + * MsgRemoveCurrencyPairs will be used explicitly by governance to remove the + * given set of currency-pairs from the module's state. Thus these + * CurrencyPairs will no longer have price-data available from this module. + */ export class MsgRemoveCurrencyPairs extends JSONSerializable< MsgRemoveCurrencyPairs.Amino, MsgRemoveCurrencyPairs.Data, diff --git a/src/core/params/ParamChange.ts b/src/core/params/ParamChange.ts index 68c8456..1a33440 100644 --- a/src/core/params/ParamChange.ts +++ b/src/core/params/ParamChange.ts @@ -41,6 +41,9 @@ export namespace ParamChanges { export type Proto = ParamChange.Proto[] } +/** + * ParamChange defines an individual parameter change, for use in ParameterChangeProposal. + */ export class ParamChange extends JSONSerializable< ParamChange.Amino, ParamChange.Data, diff --git a/src/core/params/proposals/ParameterChangeProposal.ts b/src/core/params/proposals/ParameterChangeProposal.ts index a259364..c4c2bdc 100644 --- a/src/core/params/proposals/ParameterChangeProposal.ts +++ b/src/core/params/proposals/ParameterChangeProposal.ts @@ -4,27 +4,7 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { ParameterChangeProposal as ParameterChangeProposal_pb } from '@initia/initia.proto/cosmos/params/v1beta1/params' /** - * Describes a proposal for directly altering the value of the module parameters. - * If you want to select a couple parameters to change for your proposal, you'll first - * include the subspace (module it belongs to, such as "distribution"), and - * then just the specific keys that you want to include in your changes as items in a - * JavaScript object. - * - * ```ts - * import { - * Dec, - * MsgSubmitProposal, - * ParameterChangeProposal - * } from "@initia/initia.js" - * - * const proposal = new ParameterChangeProposal("title", "description", { - * mstaking: { - * UnbondingTime: 15000000 - * } - * }) - * - * const msg = new MsgSubmitProposal() - * ``` + * ParameterChangeProposal defines a proposal to change one or more parameters. */ export class ParameterChangeProposal extends JSONSerializable< ParameterChangeProposal.Amino, diff --git a/src/core/reward/RewardParams.ts b/src/core/reward/RewardParams.ts index 411b5c1..79df897 100644 --- a/src/core/reward/RewardParams.ts +++ b/src/core/reward/RewardParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Duration } from '../Duration' import { Params as Params_pb } from '@initia/initia.proto/initia/reward/v1/types' +/** + * RewardParams defines the set of reward parameters. + */ export class RewardParams extends JSONSerializable< RewardParams.Amino, RewardParams.Data, diff --git a/src/core/reward/msgs/MsgUpdateRewardParams.ts b/src/core/reward/msgs/MsgUpdateRewardParams.ts index 3d47dd6..a3d61b7 100644 --- a/src/core/reward/msgs/MsgUpdateRewardParams.ts +++ b/src/core/reward/msgs/MsgUpdateRewardParams.ts @@ -4,6 +4,9 @@ import { RewardParams } from '../RewardParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/initia/reward/v1/tx' +/** + * MsgUpdateRewardParams defines an operation for updating the reward module parameters. + */ export class MsgUpdateRewardParams extends JSONSerializable< MsgUpdateRewardParams.Amino, MsgUpdateRewardParams.Data, diff --git a/src/core/slashing/SlashingParams.ts b/src/core/slashing/SlashingParams.ts index 4c73fdf..2be3488 100644 --- a/src/core/slashing/SlashingParams.ts +++ b/src/core/slashing/SlashingParams.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { Duration } from '../Duration' import { Params as Params_pb } from '@initia/initia.proto/cosmos/slashing/v1beta1/slashing' +/** + * SlashingParams defines the set of slashing parameters. + */ export class SlashingParams extends JSONSerializable< SlashingParams.Amino, SlashingParams.Data, diff --git a/src/core/slashing/ValidatorSigningInfo.ts b/src/core/slashing/ValidatorSigningInfo.ts index d14aae7..0073360 100644 --- a/src/core/slashing/ValidatorSigningInfo.ts +++ b/src/core/slashing/ValidatorSigningInfo.ts @@ -2,6 +2,9 @@ import { JSONSerializable } from '../../util/json' import { ValConsAddress } from '../bech32' import { ValidatorSigningInfo as ValidatorSigningInfo_pb } from '@initia/initia.proto/cosmos/slashing/v1beta1/slashing' +/** + * ValidatorSigningInfo defines a validator's signing info for monitoring their liveness activity. + */ export class ValidatorSigningInfo extends JSONSerializable< ValidatorSigningInfo.Amino, ValidatorSigningInfo.Data, diff --git a/src/core/slashing/msgs/MsgUnjail.ts b/src/core/slashing/msgs/MsgUnjail.ts index d7553c8..ae1409b 100644 --- a/src/core/slashing/msgs/MsgUnjail.ts +++ b/src/core/slashing/msgs/MsgUnjail.ts @@ -4,12 +4,9 @@ import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUnjail as MsgUnjail_pb } from '@initia/initia.proto/cosmos/slashing/v1beta1/tx' /** - * A validator can be jailed by the blockchain if misbehavior is detected, such as - * double-signing or having missed too many vote periods in the Oracle ballot. - * - * This is done to protect delegators' funds from getting slashed further, until the - * validator's issues have been addressed. A jailed validator cannot participate in - * block rewards, and must be manually unjailed by submitting this message. + * MsgUnjail defines a method for unjailing a jailed validator, thus returning + * them into the bonded validator set, so they can begin receiving provisions + * and rewards again. */ export class MsgUnjail extends JSONSerializable< MsgUnjail.Amino, diff --git a/src/core/slashing/msgs/MsgUpdateSlashingParams.ts b/src/core/slashing/msgs/MsgUpdateSlashingParams.ts index 820690d..8e2a9df 100644 --- a/src/core/slashing/msgs/MsgUpdateSlashingParams.ts +++ b/src/core/slashing/msgs/MsgUpdateSlashingParams.ts @@ -4,6 +4,9 @@ import { SlashingParams } from '../SlashingParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmos/slashing/v1beta1/tx' +/** + * MsgUpdateSlashingParams defines an operation for updating the slashing module parameters. + */ export class MsgUpdateSlashingParams extends JSONSerializable< MsgUpdateSlashingParams.Amino, MsgUpdateSlashingParams.Data, diff --git a/src/core/tx/CompactBitArray.ts b/src/core/tx/CompactBitArray.ts index f21f2f3..abcd47b 100644 --- a/src/core/tx/CompactBitArray.ts +++ b/src/core/tx/CompactBitArray.ts @@ -1,5 +1,11 @@ import { CompactBitArray as CompactBitArray_pb } from '@initia/initia.proto/cosmos/crypto/multisig/v1beta1/multisig' +/** + * CompactBitArray is an implementation of a space efficient bit array. + * This is used to ensure that the encoded data takes up a minimal amount of + * space after proto encoding. + * This is not thread safe, and is not intended for concurrent usage. + */ export class CompactBitArray { constructor( public extra_bits_stored: number, diff --git a/src/core/tx/Fee.ts b/src/core/tx/Fee.ts index a274992..3de661b 100644 --- a/src/core/tx/Fee.ts +++ b/src/core/tx/Fee.ts @@ -12,7 +12,6 @@ export class Fee extends JSONSerializable { public readonly amount: Coins /** - * Creates a new Fee object. * @param gas gas limit * @param amount amount to be paid to validator */ diff --git a/src/core/tx/SignDoc.ts b/src/core/tx/SignDoc.ts index 27ff2f9..3f46ea8 100644 --- a/src/core/tx/SignDoc.ts +++ b/src/core/tx/SignDoc.ts @@ -16,7 +16,6 @@ export class SignDoc extends JSONSerializable< SignDoc.Proto > { /** - * * @param chain_id ID of blockchain to submit transaction to * @param account_number account number on blockchain * @param sequence sequence number (nonce), number of signed previous transactions by account included on the blockchain at time of broadcast diff --git a/src/core/tx/TxInfo.ts b/src/core/tx/TxInfo.ts index feeb46d..b7fe9b0 100644 --- a/src/core/tx/TxInfo.ts +++ b/src/core/tx/TxInfo.ts @@ -6,12 +6,11 @@ import { import { Any } from '@initia/initia.proto/google/protobuf/any' /** - * A TxInfo data structure is used to capture information from a transaction lookup for + * TxInfo is used to capture information from a transaction lookup for * a transaction already included in a block */ export class TxInfo { /** - * * @param height height of the block in which the transaction was included. * @param txhash transaction's hash. * @param raw_log raw log information, as a string. diff --git a/src/core/upgrade/msgs/MsgCancelUpgrade.ts b/src/core/upgrade/msgs/MsgCancelUpgrade.ts index c91df06..e37b35d 100644 --- a/src/core/upgrade/msgs/MsgCancelUpgrade.ts +++ b/src/core/upgrade/msgs/MsgCancelUpgrade.ts @@ -12,7 +12,6 @@ export class MsgCancelUpgrade extends JSONSerializable< MsgCancelUpgrade.Proto > { /** - * * @param authority the address that controls the module */ constructor(public authority: AccAddress) { diff --git a/src/core/upgrade/msgs/MsgSoftwareUpgrade.ts b/src/core/upgrade/msgs/MsgSoftwareUpgrade.ts index 62bdeef..6b45393 100644 --- a/src/core/upgrade/msgs/MsgSoftwareUpgrade.ts +++ b/src/core/upgrade/msgs/MsgSoftwareUpgrade.ts @@ -13,7 +13,6 @@ export class MsgSoftwareUpgrade extends JSONSerializable< MsgSoftwareUpgrade.Proto > { /** - * * @param authority the address that controls the module * @param plan the upgrade plan */ diff --git a/src/core/wasm/WasmParams.ts b/src/core/wasm/WasmParams.ts index d6c3c87..6e834f2 100644 --- a/src/core/wasm/WasmParams.ts +++ b/src/core/wasm/WasmParams.ts @@ -6,6 +6,9 @@ import { } from '@initia/initia.proto/cosmwasm/wasm/v1/types' import { AccessConfig } from './AccessConfig' +/** + * WasmParams defines the set of wasm parameters. + */ export class WasmParams extends JSONSerializable< WasmParams.Amino, WasmParams.Data, diff --git a/src/core/wasm/msgs/MsgUpdateWasmParams.ts b/src/core/wasm/msgs/MsgUpdateWasmParams.ts index e37b8dc..6fee616 100644 --- a/src/core/wasm/msgs/MsgUpdateWasmParams.ts +++ b/src/core/wasm/msgs/MsgUpdateWasmParams.ts @@ -4,6 +4,9 @@ import { WasmParams } from '../WasmParams' import { Any } from '@initia/initia.proto/google/protobuf/any' import { MsgUpdateParams as MsgUpdateParams_pb } from '@initia/initia.proto/cosmwasm/wasm/v1/tx' +/** + * MsgUpdateWasmParams defines an operation for updating the wasm module parameters. + */ export class MsgUpdateWasmParams extends JSONSerializable< MsgUpdateWasmParams.Amino, MsgUpdateWasmParams.Data, @@ -11,7 +14,7 @@ export class MsgUpdateWasmParams extends JSONSerializable< > { /** * @param authority the address that controls the module - * @param params the move parameters to update + * @param params the wasm parameters to update */ constructor( public authority: AccAddress, diff --git a/src/key/Key.ts b/src/key/Key.ts index 6442094..81301af 100644 --- a/src/key/Key.ts +++ b/src/key/Key.ts @@ -23,7 +23,6 @@ export abstract class Key { /** * You will need to supply `sign`, which produces a signature for an arbitrary bytes payload * with the ECDSA curve secp256pk1. - * * @param payload the data to be signed */ public abstract sign(payload: Buffer): Promise // needs to be async for ledger key signing @@ -31,7 +30,6 @@ export abstract class Key { /** * You will need to supply `signWithKeccak256`, which produces a signature for an arbitrary bytes payload * with the ECDSA curve secp256pk1 after keccak256. - * * @param payload the data to be signed */ public abstract signWithKeccak256(payload: Buffer): Promise // needs to be async for ledger key signing @@ -64,7 +62,6 @@ export abstract class Key { /** * Called to derive the relevant account and validator addresses and public keys from * the raw compressed public key in bytes. - * * @param publicKey raw compressed bytes public key */ constructor(public publicKey?: PublicKey) {} @@ -72,7 +69,6 @@ export abstract class Key { /** * Signs a [[StdSignMsg]] with the method supplied by the child class. * only used Amino sign - * * @param tx sign-message of the transaction to sign */ public async createSignatureAmino(tx: SignDoc): Promise { @@ -96,7 +92,6 @@ export abstract class Key { /** * Signs a [[SignDoc]] with the method supplied by the child class. - * * @param tx sign-message of the transaction to sign */ public async createSignature(signDoc: SignDoc): Promise { @@ -135,7 +130,6 @@ export abstract class Key { /** * Signs a [[StdSignMsg]] with the method supplied by the child class. * only used EIP191 sign - * * @param tx sign-message of the transaction to sign */ public async createSignatureEIP191(tx: SignDoc): Promise { diff --git a/src/key/MnemonicKey.ts b/src/key/MnemonicKey.ts index 4b132ea..94de23a 100644 --- a/src/key/MnemonicKey.ts +++ b/src/key/MnemonicKey.ts @@ -70,7 +70,6 @@ export class MnemonicKey extends RawKey { * const mk2 = new MnemonicKey() * console.log(mk2.mnemonic) * ``` - * * @param options */ constructor(options: MnemonicKeyOptions = {}) { diff --git a/src/key/ledger/LedgerKey.ts b/src/key/ledger/LedgerKey.ts index 7a48cc3..571bd53 100644 --- a/src/key/ledger/LedgerKey.ts +++ b/src/key/ledger/LedgerKey.ts @@ -41,7 +41,6 @@ export class LedgerKey extends Key { private path: number[] = [44, INIT_COIN_TYPE, 0, 0, 0] /** - * * @param transport transporter for LedgerKey */ constructor(private transport?: Transport) { diff --git a/src/key/ledger/app.ts b/src/key/ledger/app.ts index d7dbb41..18b69f5 100644 --- a/src/key/ledger/app.ts +++ b/src/key/ledger/app.ts @@ -1,18 +1,18 @@ /** ****************************************************************************** - * (c) 2019 ZondaX GmbH - * (c) 2016-2017 Ledger + * (c) 2019 ZondaX GmbH + * (c) 2016-2017 Ledger * - * Licensed under the Apache License, Version 2.0 (the 'License') - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at + * Licensed under the Apache License, Version 2.0 (the 'License') + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an 'AS IS' BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an 'AS IS' BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. ******************************************************************************* */ import * as crypto from 'crypto'