injectivejs 1.11.13 → 1.11.15

package/esm/cosmos/staking/v1beta1/query.rpc.func.js

@@ -1,9 +1,14 @@
 import { buildQuery } from "../../../helper-func-types";
 import { QueryValidatorsRequest, QueryValidatorsResponse, QueryValidatorRequest, QueryValidatorResponse, QueryValidatorDelegationsRequest, QueryValidatorDelegationsResponse, QueryValidatorUnbondingDelegationsRequest, QueryValidatorUnbondingDelegationsResponse, QueryDelegationRequest, QueryDelegationResponse, QueryUnbondingDelegationRequest, QueryUnbondingDelegationResponse, QueryDelegatorDelegationsRequest, QueryDelegatorDelegationsResponse, QueryDelegatorUnbondingDelegationsRequest, QueryDelegatorUnbondingDelegationsResponse, QueryRedelegationsRequest, QueryRedelegationsResponse, QueryDelegatorValidatorsRequest, QueryDelegatorValidatorsResponse, QueryDelegatorValidatorRequest, QueryDelegatorValidatorResponse, QueryHistoricalInfoRequest, QueryHistoricalInfoResponse, QueryPoolRequest, QueryPoolResponse, QueryParamsRequest, QueryParamsResponse } from "./query";
-/* Validators queries all validators that match the given status.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * Validators queries all validators that match the given status.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getValidators
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Validators
+ */
 export const getValidators = buildQuery({
     encode: QueryValidatorsRequest.encode,
     decode: QueryValidatorsResponse.decode,
@@ -11,7 +16,12 @@ export const getValidators = buildQuery({
     method: "Validators",
     deps: [QueryValidatorsRequest, QueryValidatorsResponse]
 });
-/* Validator queries validator info for given validator address. */
+/**
+ * Validator queries validator info for given validator address.
+ * @name getValidator
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Validator
+ */
 export const getValidator = buildQuery({
     encode: QueryValidatorRequest.encode,
     decode: QueryValidatorResponse.decode,
@@ -19,10 +29,15 @@ export const getValidator = buildQuery({
     method: "Validator",
     deps: [QueryValidatorRequest, QueryValidatorResponse]
 });
-/* ValidatorDelegations queries delegate info for given validator.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * ValidatorDelegations queries delegate info for given validator.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getValidatorDelegations
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.ValidatorDelegations
+ */
 export const getValidatorDelegations = buildQuery({
     encode: QueryValidatorDelegationsRequest.encode,
     decode: QueryValidatorDelegationsResponse.decode,
@@ -30,10 +45,15 @@ export const getValidatorDelegations = buildQuery({
     method: "ValidatorDelegations",
     deps: [QueryValidatorDelegationsRequest, QueryValidatorDelegationsResponse]
 });
-/* ValidatorUnbondingDelegations queries unbonding delegations of a validator.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * ValidatorUnbondingDelegations queries unbonding delegations of a validator.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getValidatorUnbondingDelegations
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.ValidatorUnbondingDelegations
+ */
 export const getValidatorUnbondingDelegations = buildQuery({
     encode: QueryValidatorUnbondingDelegationsRequest.encode,
     decode: QueryValidatorUnbondingDelegationsResponse.decode,
@@ -41,7 +61,12 @@ export const getValidatorUnbondingDelegations = buildQuery({
     method: "ValidatorUnbondingDelegations",
     deps: [QueryValidatorUnbondingDelegationsRequest, QueryValidatorUnbondingDelegationsResponse]
 });
-/* Delegation queries delegate info for given validator delegator pair. */
+/**
+ * Delegation queries delegate info for given validator delegator pair.
+ * @name getDelegation
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Delegation
+ */
 export const getDelegation = buildQuery({
     encode: QueryDelegationRequest.encode,
     decode: QueryDelegationResponse.decode,
@@ -49,8 +74,13 @@ export const getDelegation = buildQuery({
     method: "Delegation",
     deps: [QueryDelegationRequest, QueryDelegationResponse]
 });
-/* UnbondingDelegation queries unbonding info for given validator delegator
- pair. */
+/**
+ * UnbondingDelegation queries unbonding info for given validator delegator
+ * pair.
+ * @name getUnbondingDelegation
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.UnbondingDelegation
+ */
 export const getUnbondingDelegation = buildQuery({
     encode: QueryUnbondingDelegationRequest.encode,
     decode: QueryUnbondingDelegationResponse.decode,
@@ -58,10 +88,15 @@ export const getUnbondingDelegation = buildQuery({
     method: "UnbondingDelegation",
     deps: [QueryUnbondingDelegationRequest, QueryUnbondingDelegationResponse]
 });
-/* DelegatorDelegations queries all delegations of a given delegator address.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * DelegatorDelegations queries all delegations of a given delegator address.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getDelegatorDelegations
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.DelegatorDelegations
+ */
 export const getDelegatorDelegations = buildQuery({
     encode: QueryDelegatorDelegationsRequest.encode,
     decode: QueryDelegatorDelegationsResponse.decode,
@@ -69,11 +104,16 @@ export const getDelegatorDelegations = buildQuery({
     method: "DelegatorDelegations",
     deps: [QueryDelegatorDelegationsRequest, QueryDelegatorDelegationsResponse]
 });
-/* DelegatorUnbondingDelegations queries all unbonding delegations of a given
- delegator address.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * DelegatorUnbondingDelegations queries all unbonding delegations of a given
+ * delegator address.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getDelegatorUnbondingDelegations
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.DelegatorUnbondingDelegations
+ */
 export const getDelegatorUnbondingDelegations = buildQuery({
     encode: QueryDelegatorUnbondingDelegationsRequest.encode,
     decode: QueryDelegatorUnbondingDelegationsResponse.decode,
@@ -81,10 +121,15 @@ export const getDelegatorUnbondingDelegations = buildQuery({
     method: "DelegatorUnbondingDelegations",
     deps: [QueryDelegatorUnbondingDelegationsRequest, QueryDelegatorUnbondingDelegationsResponse]
 });
-/* Redelegations queries redelegations of given address.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * Redelegations queries redelegations of given address.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getRedelegations
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Redelegations
+ */
 export const getRedelegations = buildQuery({
     encode: QueryRedelegationsRequest.encode,
     decode: QueryRedelegationsResponse.decode,
@@ -92,11 +137,16 @@ export const getRedelegations = buildQuery({
     method: "Redelegations",
     deps: [QueryRedelegationsRequest, QueryRedelegationsResponse]
 });
-/* DelegatorValidators queries all validators info for given delegator
- address.
-
- When called from another module, this query might consume a high amount of
- gas if the pagination field is incorrectly set. */
+/**
+ * DelegatorValidators queries all validators info for given delegator
+ * address.
+ *
+ * When called from another module, this query might consume a high amount of
+ * gas if the pagination field is incorrectly set.
+ * @name getDelegatorValidators
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.DelegatorValidators
+ */
 export const getDelegatorValidators = buildQuery({
     encode: QueryDelegatorValidatorsRequest.encode,
     decode: QueryDelegatorValidatorsResponse.decode,
@@ -104,8 +154,13 @@ export const getDelegatorValidators = buildQuery({
     method: "DelegatorValidators",
     deps: [QueryDelegatorValidatorsRequest, QueryDelegatorValidatorsResponse]
 });
-/* DelegatorValidator queries validator info for given delegator validator
- pair. */
+/**
+ * DelegatorValidator queries validator info for given delegator validator
+ * pair.
+ * @name getDelegatorValidator
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.DelegatorValidator
+ */
 export const getDelegatorValidator = buildQuery({
     encode: QueryDelegatorValidatorRequest.encode,
     decode: QueryDelegatorValidatorResponse.decode,
@@ -113,7 +168,12 @@ export const getDelegatorValidator = buildQuery({
     method: "DelegatorValidator",
     deps: [QueryDelegatorValidatorRequest, QueryDelegatorValidatorResponse]
 });
-/* HistoricalInfo queries the historical info for given height. */
+/**
+ * HistoricalInfo queries the historical info for given height.
+ * @name getHistoricalInfo
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.HistoricalInfo
+ */
 export const getHistoricalInfo = buildQuery({
     encode: QueryHistoricalInfoRequest.encode,
     decode: QueryHistoricalInfoResponse.decode,
@@ -121,7 +181,12 @@ export const getHistoricalInfo = buildQuery({
     method: "HistoricalInfo",
     deps: [QueryHistoricalInfoRequest, QueryHistoricalInfoResponse]
 });
-/* Pool queries the pool info. */
+/**
+ * Pool queries the pool info.
+ * @name getPool
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Pool
+ */
 export const getPool = buildQuery({
     encode: QueryPoolRequest.encode,
     decode: QueryPoolResponse.decode,
@@ -129,7 +194,12 @@ export const getPool = buildQuery({
     method: "Pool",
     deps: [QueryPoolRequest, QueryPoolResponse]
 });
-/* Parameters queries the staking parameters. */
+/**
+ * Parameters queries the staking parameters.
+ * @name getParams
+ * @package cosmos.staking.v1beta1
+ * @see proto service: cosmos.staking.v1beta1.Params
+ */
 export const getParams = buildQuery({
     encode: QueryParamsRequest.encode,
     decode: QueryParamsResponse.decode,

package/esm/cosmos/staking/v1beta1/staking.js

@@ -106,6 +106,15 @@ function createBaseHistoricalInfo() {
         valset: []
     };
 }
+/**
+ * HistoricalInfo contains header and validator information for a given block.
+ * It is stored as part of staking module's state, which persists the `n` most
+ * recent HistoricalInfo
+ * (`n` is set by the staking module's `historical_entries` parameter).
+ * @name HistoricalInfo
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.HistoricalInfo
+ */
 export const HistoricalInfo = {
     typeUrl: "/cosmos.staking.v1beta1.HistoricalInfo",
     aminoType: "cosmos-sdk/HistoricalInfo",
@@ -205,6 +214,13 @@ function createBaseCommissionRates() {
         maxChangeRate: ""
     };
 }
+/**
+ * CommissionRates defines the initial commission rates to be used for creating
+ * a validator.
+ * @name CommissionRates
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.CommissionRates
+ */
 export const CommissionRates = {
     typeUrl: "/cosmos.staking.v1beta1.CommissionRates",
     aminoType: "cosmos-sdk/CommissionRates",
@@ -305,6 +321,12 @@ function createBaseCommission() {
         updateTime: new Date()
     };
 }
+/**
+ * Commission defines commission parameters for a given validator.
+ * @name Commission
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Commission
+ */
 export const Commission = {
     typeUrl: "/cosmos.staking.v1beta1.Commission",
     aminoType: "cosmos-sdk/Commission",
@@ -402,6 +424,12 @@ function createBaseDescription() {
         details: ""
     };
 }
+/**
+ * Description defines a validator description.
+ * @name Description
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Description
+ */
 export const Description = {
     typeUrl: "/cosmos.staking.v1beta1.Description",
     aminoType: "cosmos-sdk/Description",
@@ -535,6 +563,19 @@ function createBaseValidator() {
         unbondingIds: []
     };
 }
+/**
+ * Validator defines a validator, together with the total amount of the
+ * Validator's bond shares and their exchange rate to coins. Slashing results in
+ * a decrease in the exchange rate, allowing correct calculation of future
+ * undelegations without iterating over delegators. When coins are delegated to
+ * this validator, the validator is credited with a delegation whose number of
+ * bond shares is based on the amount of coins delegated divided by the current
+ * exchange rate. Voting power can be calculated as total bonded shares
+ * multiplied by exchange rate.
+ * @name Validator
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Validator
+ */
 export const Validator = {
     typeUrl: "/cosmos.staking.v1beta1.Validator",
     aminoType: "cosmos-sdk/Validator",
@@ -763,6 +804,12 @@ function createBaseValAddresses() {
         addresses: []
     };
 }
+/**
+ * ValAddresses defines a repeated set of validator addresses.
+ * @name ValAddresses
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.ValAddresses
+ */
 export const ValAddresses = {
     typeUrl: "/cosmos.staking.v1beta1.ValAddresses",
     aminoType: "cosmos-sdk/ValAddresses",
@@ -844,6 +891,14 @@ function createBaseDVPair() {
         validatorAddress: ""
     };
 }
+/**
+ * DVPair is struct that just has a delegator-validator pair with no other data.
+ * It is intended to be used as a marshalable pointer. For example, a DVPair can
+ * be used to construct the key to getting an UnbondingDelegation from state.
+ * @name DVPair
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVPair
+ */
 export const DVPair = {
     typeUrl: "/cosmos.staking.v1beta1.DVPair",
     aminoType: "cosmos-sdk/DVPair",
@@ -932,6 +987,12 @@ function createBaseDVPairs() {
         pairs: []
     };
 }
+/**
+ * DVPairs defines an array of DVPair objects.
+ * @name DVPairs
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVPairs
+ */
 export const DVPairs = {
     typeUrl: "/cosmos.staking.v1beta1.DVPairs",
     aminoType: "cosmos-sdk/DVPairs",
@@ -1019,6 +1080,15 @@ function createBaseDVVTriplet() {
         validatorDstAddress: ""
     };
 }
+/**
+ * DVVTriplet is struct that just has a delegator-validator-validator triplet
+ * with no other data. It is intended to be used as a marshalable pointer. For
+ * example, a DVVTriplet can be used to construct the key to getting a
+ * Redelegation from state.
+ * @name DVVTriplet
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVVTriplet
+ */
 export const DVVTriplet = {
     typeUrl: "/cosmos.staking.v1beta1.DVVTriplet",
     aminoType: "cosmos-sdk/DVVTriplet",
@@ -1118,6 +1188,12 @@ function createBaseDVVTriplets() {
         triplets: []
     };
 }
+/**
+ * DVVTriplets defines an array of DVVTriplet objects.
+ * @name DVVTriplets
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVVTriplets
+ */
 export const DVVTriplets = {
     typeUrl: "/cosmos.staking.v1beta1.DVVTriplets",
     aminoType: "cosmos-sdk/DVVTriplets",
@@ -1205,6 +1281,14 @@ function createBaseDelegation() {
         shares: ""
     };
 }
+/**
+ * Delegation represents the bond with tokens held by an account. It is
+ * owned by one delegator, and is associated with the voting power of one
+ * validator.
+ * @name Delegation
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Delegation
+ */
 export const Delegation = {
     typeUrl: "/cosmos.staking.v1beta1.Delegation",
     aminoType: "cosmos-sdk/Delegation",
@@ -1306,6 +1390,13 @@ function createBaseUnbondingDelegation() {
         entries: []
     };
 }
+/**
+ * UnbondingDelegation stores all of a single delegator's unbonding bonds
+ * for a single validator in an time-ordered list.
+ * @name UnbondingDelegation
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.UnbondingDelegation
+ */
 export const UnbondingDelegation = {
     typeUrl: "/cosmos.staking.v1beta1.UnbondingDelegation",
     aminoType: "cosmos-sdk/UnbondingDelegation",
@@ -1418,6 +1509,12 @@ function createBaseUnbondingDelegationEntry() {
         unbondingOnHoldRefCount: BigInt(0)
     };
 }
+/**
+ * UnbondingDelegationEntry defines an unbonding object with relevant metadata.
+ * @name UnbondingDelegationEntry
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.UnbondingDelegationEntry
+ */
 export const UnbondingDelegationEntry = {
     typeUrl: "/cosmos.staking.v1beta1.UnbondingDelegationEntry",
     aminoType: "cosmos-sdk/UnbondingDelegationEntry",
@@ -1555,6 +1652,12 @@ function createBaseRedelegationEntry() {
         unbondingOnHoldRefCount: BigInt(0)
     };
 }
+/**
+ * RedelegationEntry defines a redelegation object with relevant metadata.
+ * @name RedelegationEntry
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.RedelegationEntry
+ */
 export const RedelegationEntry = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationEntry",
     aminoType: "cosmos-sdk/RedelegationEntry",
@@ -1690,6 +1793,13 @@ function createBaseRedelegation() {
         entries: []
     };
 }
+/**
+ * Redelegation contains the list of a particular delegator's redelegating bonds
+ * from a particular source validator to a particular destination validator.
+ * @name Redelegation
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Redelegation
+ */
 export const Redelegation = {
     typeUrl: "/cosmos.staking.v1beta1.Redelegation",
     aminoType: "cosmos-sdk/Redelegation",
@@ -1813,6 +1923,12 @@ function createBaseParams() {
         minCommissionRate: ""
     };
 }
+/**
+ * Params defines the parameters for the x/staking module.
+ * @name Params
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Params
+ */
 export const Params = {
     typeUrl: "/cosmos.staking.v1beta1.Params",
     aminoType: "cosmos-sdk/x/staking/Params",
@@ -1946,6 +2062,13 @@ function createBaseDelegationResponse() {
         balance: Coin.fromPartial({})
     };
 }
+/**
+ * DelegationResponse is equivalent to Delegation except that it contains a
+ * balance in addition to shares which is more suitable for client responses.
+ * @name DelegationResponse
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DelegationResponse
+ */
 export const DelegationResponse = {
     typeUrl: "/cosmos.staking.v1beta1.DelegationResponse",
     aminoType: "cosmos-sdk/DelegationResponse",
@@ -2041,6 +2164,14 @@ function createBaseRedelegationEntryResponse() {
         balance: ""
     };
 }
+/**
+ * RedelegationEntryResponse is equivalent to a RedelegationEntry except that it
+ * contains a balance in addition to shares which is more suitable for client
+ * responses.
+ * @name RedelegationEntryResponse
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.RedelegationEntryResponse
+ */
 export const RedelegationEntryResponse = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationEntryResponse",
     aminoType: "cosmos-sdk/RedelegationEntryResponse",
@@ -2135,6 +2266,14 @@ function createBaseRedelegationResponse() {
         entries: []
     };
 }
+/**
+ * RedelegationResponse is equivalent to a Redelegation except that its entries
+ * contain a balance in addition to shares which is more suitable for client
+ * responses.
+ * @name RedelegationResponse
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.RedelegationResponse
+ */
 export const RedelegationResponse = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationResponse",
     aminoType: "cosmos-sdk/RedelegationResponse",
@@ -2233,6 +2372,13 @@ function createBasePool() {
         bondedTokens: ""
     };
 }
+/**
+ * Pool is used for tracking bonded and not-bonded token supply of the bond
+ * denomination.
+ * @name Pool
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Pool
+ */
 export const Pool = {
     typeUrl: "/cosmos.staking.v1beta1.Pool",
     aminoType: "cosmos-sdk/Pool",
@@ -2321,6 +2467,13 @@ function createBaseValidatorUpdates() {
         updates: []
     };
 }
+/**
+ * ValidatorUpdates defines an array of abci.ValidatorUpdate objects.
+ * TODO: explore moving this to proto/cosmos/base to separate modules from tendermint dependence
+ * @name ValidatorUpdates
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.ValidatorUpdates
+ */
 export const ValidatorUpdates = {
     typeUrl: "/cosmos.staking.v1beta1.ValidatorUpdates",
     aminoType: "cosmos-sdk/ValidatorUpdates",