@sparkdreamnft/sparkdreamjs 0.0.5 → 0.0.7

package/cosmos/staking/v1beta1/staking.js

@@ -113,6 +113,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
+ */
 exports.HistoricalInfo = {
     typeUrl: "/cosmos.staking.v1beta1.HistoricalInfo",
     aminoType: "cosmos-sdk/HistoricalInfo",
@@ -199,6 +208,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
+ */
 exports.CommissionRates = {
     typeUrl: "/cosmos.staking.v1beta1.CommissionRates",
     aminoType: "cosmos-sdk/CommissionRates",
@@ -292,6 +308,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
+ */
 exports.Commission = {
     typeUrl: "/cosmos.staking.v1beta1.Commission",
     aminoType: "cosmos-sdk/Commission",
@@ -377,6 +399,12 @@ function createBaseDescription() {
         details: ""
     };
 }
+/**
+ * Description defines a validator description.
+ * @name Description
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.Description
+ */
 exports.Description = {
     typeUrl: "/cosmos.staking.v1beta1.Description",
     aminoType: "cosmos-sdk/Description",
@@ -503,6 +531,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
+ */
 exports.Validator = {
     typeUrl: "/cosmos.staking.v1beta1.Validator",
     aminoType: "cosmos-sdk/Validator",
@@ -718,6 +759,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
+ */
 exports.ValAddresses = {
     typeUrl: "/cosmos.staking.v1beta1.ValAddresses",
     aminoType: "cosmos-sdk/ValAddresses",
@@ -792,6 +839,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
+ */
 exports.DVPair = {
     typeUrl: "/cosmos.staking.v1beta1.DVPair",
     aminoType: "cosmos-sdk/DVPair",
@@ -873,6 +928,12 @@ function createBaseDVPairs() {
         pairs: []
     };
 }
+/**
+ * DVPairs defines an array of DVPair objects.
+ * @name DVPairs
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVPairs
+ */
 exports.DVPairs = {
     typeUrl: "/cosmos.staking.v1beta1.DVPairs",
     aminoType: "cosmos-sdk/DVPairs",
@@ -948,6 +1009,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
+ */
 exports.DVVTriplet = {
     typeUrl: "/cosmos.staking.v1beta1.DVVTriplet",
     aminoType: "cosmos-sdk/DVVTriplet",
@@ -1040,6 +1110,12 @@ function createBaseDVVTriplets() {
         triplets: []
     };
 }
+/**
+ * DVVTriplets defines an array of DVVTriplet objects.
+ * @name DVVTriplets
+ * @package cosmos.staking.v1beta1
+ * @see proto type: cosmos.staking.v1beta1.DVVTriplets
+ */
 exports.DVVTriplets = {
     typeUrl: "/cosmos.staking.v1beta1.DVVTriplets",
     aminoType: "cosmos-sdk/DVVTriplets",
@@ -1115,6 +1191,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
+ */
 exports.Delegation = {
     typeUrl: "/cosmos.staking.v1beta1.Delegation",
     aminoType: "cosmos-sdk/Delegation",
@@ -1209,6 +1293,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
+ */
 exports.UnbondingDelegation = {
     typeUrl: "/cosmos.staking.v1beta1.UnbondingDelegation",
     aminoType: "cosmos-sdk/UnbondingDelegation",
@@ -1309,6 +1400,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
+ */
 exports.UnbondingDelegationEntry = {
     typeUrl: "/cosmos.staking.v1beta1.UnbondingDelegationEntry",
     aminoType: "cosmos-sdk/UnbondingDelegationEntry",
@@ -1439,6 +1536,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
+ */
 exports.RedelegationEntry = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationEntry",
     aminoType: "cosmos-sdk/RedelegationEntry",
@@ -1567,6 +1670,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
+ */
 exports.Redelegation = {
     typeUrl: "/cosmos.staking.v1beta1.Redelegation",
     aminoType: "cosmos-sdk/Redelegation",
@@ -1678,6 +1788,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
+ */
 exports.Params = {
     typeUrl: "/cosmos.staking.v1beta1.Params",
     aminoType: "cosmos-sdk/x/staking/Params",
@@ -1804,6 +1920,13 @@ function createBaseDelegationResponse() {
         balance: coin_1.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
+ */
 exports.DelegationResponse = {
     typeUrl: "/cosmos.staking.v1beta1.DelegationResponse",
     aminoType: "cosmos-sdk/DelegationResponse",
@@ -1886,6 +2009,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
+ */
 exports.RedelegationEntryResponse = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationEntryResponse",
     aminoType: "cosmos-sdk/RedelegationEntryResponse",
@@ -1968,6 +2099,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
+ */
 exports.RedelegationResponse = {
     typeUrl: "/cosmos.staking.v1beta1.RedelegationResponse",
     aminoType: "cosmos-sdk/RedelegationResponse",
@@ -2053,6 +2192,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
+ */
 exports.Pool = {
     typeUrl: "/cosmos.staking.v1beta1.Pool",
     aminoType: "cosmos-sdk/Pool",
@@ -2134,6 +2280,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
+ */
 exports.ValidatorUpdates = {
     typeUrl: "/cosmos.staking.v1beta1.ValidatorUpdates",
     aminoType: "cosmos-sdk/ValidatorUpdates",