Merge pull request #774 from hyperweb-io/generate-comments-for-helperfuncs

Added comments for query and msg funcs

Author: Zetazzz

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.func.ts

@@ -5,62 +5,74 @@ import { EndpointOrRpc, buildQuery } from "../../../helper-func-types";
 import { buildUseQuery } from "../../../react-query";
 import { buildUseVueQuery } from "../../../vue-query";
 import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
+/* Balance queries the balance of a single coin for a single account. */
 export const getBalance = buildQuery<QueryBalanceRequest, QueryBalanceResponse>({
   encode: QueryBalanceRequest.encode,
   decode: QueryBalanceResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "Balance",
   deps: [QueryBalanceRequest, QueryBalanceResponse]
 });
+/* AllBalances queries the balance of all coins for a single account. */
 export const getAllBalances = buildQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
   encode: QueryAllBalancesRequest.encode,
   decode: QueryAllBalancesResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "AllBalances",
   deps: [QueryAllBalancesRequest, QueryAllBalancesResponse]
 });
+/* SpendableBalances queries the spenable balance of all coins for a single
+ account. */
 export const getSpendableBalances = buildQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
   encode: QuerySpendableBalancesRequest.encode,
   decode: QuerySpendableBalancesResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "SpendableBalances",
   deps: [QuerySpendableBalancesRequest, QuerySpendableBalancesResponse]
 });
+/* TotalSupply queries the total supply of all coins. */
 export const getTotalSupply = buildQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
   encode: QueryTotalSupplyRequest.encode,
   decode: QueryTotalSupplyResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "TotalSupply",
   deps: [QueryTotalSupplyRequest, QueryTotalSupplyResponse]
 });
+/* SupplyOf queries the supply of a single coin. */
 export const getSupplyOf = buildQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
   encode: QuerySupplyOfRequest.encode,
   decode: QuerySupplyOfResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "SupplyOf",
   deps: [QuerySupplyOfRequest, QuerySupplyOfResponse]
 });
+/* Params queries the parameters of x/bank module. */
 export const getParams = buildQuery<QueryParamsRequest, QueryParamsResponse>({
   encode: QueryParamsRequest.encode,
   decode: QueryParamsResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "Params",
   deps: [QueryParamsRequest, QueryParamsResponse]
 });
+/* DenomsMetadata queries the client metadata of a given coin denomination. */
 export const getDenomMetadata = buildQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
   encode: QueryDenomMetadataRequest.encode,
   decode: QueryDenomMetadataResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "DenomMetadata",
   deps: [QueryDenomMetadataRequest, QueryDenomMetadataResponse]
 });
+/* DenomsMetadata queries the client metadata for all registered coin
+ denominations. */
 export const getDenomsMetadata = buildQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
   encode: QueryDenomsMetadataRequest.encode,
   decode: QueryDenomsMetadataResponse.decode,
   service: "cosmos.bank.v1beta1.Query",
   method: "DenomsMetadata",
   deps: [QueryDenomsMetadataRequest, QueryDenomsMetadataResponse]
 });
+/* DenomOwners queries for all account addresses that own a particular token
+ denomination. */
 export const getDenomOwners = buildQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
   encode: QueryDenomOwnersRequest.encode,
   decode: QueryDenomOwnersResponse.decode,

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.react.ts

@@ -6,38 +6,50 @@ import { buildUseQuery } from "../../../react-query";
 import { buildUseVueQuery } from "../../../vue-query";
 import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
 import { getBalance, getAllBalances, getSpendableBalances, getTotalSupply, getSupplyOf, getParams, getDenomMetadata, getDenomsMetadata, getDenomOwners } from "./query.rpc.func";
+/* Balance queries the balance of a single coin for a single account. */
 export const useGetBalance = buildUseQuery<QueryBalanceRequest, QueryBalanceResponse>({
   builderQueryFn: getBalance,
   queryKeyPrefix: "BalanceQuery"
 });
+/* AllBalances queries the balance of all coins for a single account. */
 export const useGetAllBalances = buildUseQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
   builderQueryFn: getAllBalances,
   queryKeyPrefix: "AllBalancesQuery"
 });
+/* SpendableBalances queries the spenable balance of all coins for a single
+ account. */
 export const useGetSpendableBalances = buildUseQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
   builderQueryFn: getSpendableBalances,
   queryKeyPrefix: "SpendableBalancesQuery"
 });
+/* TotalSupply queries the total supply of all coins. */
 export const useGetTotalSupply = buildUseQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
   builderQueryFn: getTotalSupply,
   queryKeyPrefix: "TotalSupplyQuery"
 });
+/* SupplyOf queries the supply of a single coin. */
 export const useGetSupplyOf = buildUseQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
   builderQueryFn: getSupplyOf,
   queryKeyPrefix: "SupplyOfQuery"
 });
+/* Params queries the parameters of x/bank module. */
 export const useGetParams = buildUseQuery<QueryParamsRequest, QueryParamsResponse>({
   builderQueryFn: getParams,
   queryKeyPrefix: "ParamsQuery"
 });
+/* DenomsMetadata queries the client metadata of a given coin denomination. */
 export const useGetDenomMetadata = buildUseQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
   builderQueryFn: getDenomMetadata,
   queryKeyPrefix: "DenomMetadataQuery"
 });
+/* DenomsMetadata queries the client metadata for all registered coin
+ denominations. */
 export const useGetDenomsMetadata = buildUseQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
   builderQueryFn: getDenomsMetadata,
   queryKeyPrefix: "DenomsMetadataQuery"
 });
+/* DenomOwners queries for all account addresses that own a particular token
+ denomination. */
 export const useGetDenomOwners = buildUseQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
   builderQueryFn: getDenomOwners,
   queryKeyPrefix: "DenomOwnersQuery"

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.vue.ts

@@ -6,38 +6,50 @@ import { buildUseQuery } from "../../../react-query";
 import { buildUseVueQuery } from "../../../vue-query";
 import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
 import { getBalance, getAllBalances, getSpendableBalances, getTotalSupply, getSupplyOf, getParams, getDenomMetadata, getDenomsMetadata, getDenomOwners } from "./query.rpc.func";
+/* Balance queries the balance of a single coin for a single account. */
 export const useGetBalance = buildUseVueQuery<QueryBalanceRequest, QueryBalanceResponse>({
   builderQueryFn: getBalance,
   queryKeyPrefix: "BalanceQuery"
 });
+/* AllBalances queries the balance of all coins for a single account. */
 export const useGetAllBalances = buildUseVueQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
   builderQueryFn: getAllBalances,
   queryKeyPrefix: "AllBalancesQuery"
 });
+/* SpendableBalances queries the spenable balance of all coins for a single
+ account. */
 export const useGetSpendableBalances = buildUseVueQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
   builderQueryFn: getSpendableBalances,
   queryKeyPrefix: "SpendableBalancesQuery"
 });
+/* TotalSupply queries the total supply of all coins. */
 export const useGetTotalSupply = buildUseVueQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
   builderQueryFn: getTotalSupply,
   queryKeyPrefix: "TotalSupplyQuery"
 });
+/* SupplyOf queries the supply of a single coin. */
 export const useGetSupplyOf = buildUseVueQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
   builderQueryFn: getSupplyOf,
   queryKeyPrefix: "SupplyOfQuery"
 });
+/* Params queries the parameters of x/bank module. */
 export const useGetParams = buildUseVueQuery<QueryParamsRequest, QueryParamsResponse>({
   builderQueryFn: getParams,
   queryKeyPrefix: "ParamsQuery"
 });
+/* DenomsMetadata queries the client metadata of a given coin denomination. */
 export const useGetDenomMetadata = buildUseVueQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
   builderQueryFn: getDenomMetadata,
   queryKeyPrefix: "DenomMetadataQuery"
 });
+/* DenomsMetadata queries the client metadata for all registered coin
+ denominations. */
 export const useGetDenomsMetadata = buildUseVueQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
   builderQueryFn: getDenomsMetadata,
   queryKeyPrefix: "DenomsMetadataQuery"
 });
+/* DenomOwners queries for all account addresses that own a particular token
+ denomination. */
 export const useGetDenomOwners = buildUseVueQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
   builderQueryFn: getDenomOwners,
   queryKeyPrefix: "DenomOwnersQuery"

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/tx.rpc.func.ts

@@ -4,9 +4,11 @@ import { buildTx } from "../../../helper-func-types";
 import { buildUseMutation } from "../../../react-query";
 import { buildUseVueMutation } from "../../../vue-query";
 import { MsgSend, MsgSendSDKType, MsgSendResponse, MsgSendResponseSDKType, MsgMultiSend, MsgMultiSendSDKType, MsgMultiSendResponse, MsgMultiSendResponseSDKType } from "./tx";
+/* Send defines a method for sending coins from one account to another account. */
 export const send = buildTx<MsgSend>({
   msg: MsgSend
 });
+/* MultiSend defines a method for sending coins from some accounts to other accounts. */
 export const multiSend = buildTx<MsgMultiSend>({
   msg: MsgMultiSend
 });

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/tx.rpc.react.ts

@@ -5,9 +5,11 @@ import { buildUseMutation } from "../../../react-query";
 import { buildUseVueMutation } from "../../../vue-query";
 import { MsgSend, MsgSendSDKType, MsgSendResponse, MsgSendResponseSDKType, MsgMultiSend, MsgMultiSendSDKType, MsgMultiSendResponse, MsgMultiSendResponseSDKType } from "./tx";
 import { send, multiSend } from "./tx.rpc.func";
+/* Send defines a method for sending coins from one account to another account. */
 export const useSend = buildUseMutation<MsgSend, Error>({
   builderMutationFn: send
 });
+/* MultiSend defines a method for sending coins from some accounts to other accounts. */
 export const useMultiSend = buildUseMutation<MsgMultiSend, Error>({
   builderMutationFn: multiSend
 });

__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/tx.rpc.vue.ts

@@ -5,9 +5,11 @@ import { buildUseMutation } from "../../../react-query";
 import { buildUseVueMutation } from "../../../vue-query";
 import { MsgSend, MsgSendSDKType, MsgSendResponse, MsgSendResponseSDKType, MsgMultiSend, MsgMultiSendSDKType, MsgMultiSendResponse, MsgMultiSendResponseSDKType } from "./tx";
 import { send, multiSend } from "./tx.rpc.func";
+/* Send defines a method for sending coins from one account to another account. */
 export const useSend = buildUseVueMutation<MsgSend, Error>({
   builderMutationFn: send
 });
+/* MultiSend defines a method for sending coins from some accounts to other accounts. */
 export const useMultiSend = buildUseVueMutation<MsgMultiSend, Error>({
   builderMutationFn: multiSend
 });

__fixtures__/v-next/outputhelperfunc/cosmos/gov/v1beta1/query.rpc.func.ts

@@ -4,55 +4,63 @@ import { EndpointOrRpc, buildQuery } from "../../../helper-func-types";
 import { buildUseQuery } from "../../../react-query";
 import { buildUseVueQuery } from "../../../vue-query";
 import { QueryProposalRequest, QueryProposalRequestSDKType, QueryProposalResponse, QueryProposalResponseSDKType, QueryProposalsRequest, QueryProposalsRequestSDKType, QueryProposalsResponse, QueryProposalsResponseSDKType, QueryVoteRequest, QueryVoteRequestSDKType, QueryVoteResponse, QueryVoteResponseSDKType, QueryVotesRequest, QueryVotesRequestSDKType, QueryVotesResponse, QueryVotesResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDepositRequest, QueryDepositRequestSDKType, QueryDepositResponse, QueryDepositResponseSDKType, QueryDepositsRequest, QueryDepositsRequestSDKType, QueryDepositsResponse, QueryDepositsResponseSDKType, QueryTallyResultRequest, QueryTallyResultRequestSDKType, QueryTallyResultResponse, QueryTallyResultResponseSDKType } from "./query";
+/* Proposal queries proposal details based on ProposalID. */
 export const getProposal = buildQuery<QueryProposalRequest, QueryProposalResponse>({
   encode: QueryProposalRequest.encode,
   decode: QueryProposalResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Proposal",
   deps: [QueryProposalRequest, QueryProposalResponse]
 });
+/* Proposals queries all proposals based on given status. */
 export const getProposals = buildQuery<QueryProposalsRequest, QueryProposalsResponse>({
   encode: QueryProposalsRequest.encode,
   decode: QueryProposalsResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Proposals",
   deps: [QueryProposalsRequest, QueryProposalsResponse]
 });
+/* Vote queries voted information based on proposalID, voterAddr. */
 export const helperVote = buildQuery<QueryVoteRequest, QueryVoteResponse>({
   encode: QueryVoteRequest.encode,
   decode: QueryVoteResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Vote",
   deps: [QueryVoteRequest, QueryVoteResponse]
 });
+/* Votes queries votes of a given proposal. */
 export const helperVotes = buildQuery<QueryVotesRequest, QueryVotesResponse>({
   encode: QueryVotesRequest.encode,
   decode: QueryVotesResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Votes",
   deps: [QueryVotesRequest, QueryVotesResponse]
 });
+/* Params queries all parameters of the gov module. */
 export const getParams = buildQuery<QueryParamsRequest, QueryParamsResponse>({
   encode: QueryParamsRequest.encode,
   decode: QueryParamsResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Params",
   deps: [QueryParamsRequest, QueryParamsResponse]
 });
+/* Deposit queries single deposit information based proposalID, depositAddr. */
 export const checkDeposit = buildQuery<QueryDepositRequest, QueryDepositResponse>({
   encode: QueryDepositRequest.encode,
   decode: QueryDepositResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Deposit",
   deps: [QueryDepositRequest, QueryDepositResponse]
 });
+/* Deposits queries all deposits of a single proposal. */
 export const goOverDeposits = buildQuery<QueryDepositsRequest, QueryDepositsResponse>({
   encode: QueryDepositsRequest.encode,
   decode: QueryDepositsResponse.decode,
   service: "cosmos.gov.v1beta1.Query",
   method: "Deposits",
   deps: [QueryDepositsRequest, QueryDepositsResponse]
 });
+/* TallyResult queries the tally of a proposal vote. */
 export const getTallyResult = buildQuery<QueryTallyResultRequest, QueryTallyResultResponse>({
   encode: QueryTallyResultRequest.encode,
   decode: QueryTallyResultResponse.decode,