{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Cosmos SDK cosmos.distribution.v1beta1 Schemas", "description": "JSON Schema definitions for the cosmos.distribution.v1beta1 module of the Cosmos SDK gRPC-gateway REST API.", "definitions": { "cosmos.distribution.v1beta1.DelegationDelegatorReward": { "type": "object", "properties": { "validatorAddress": { "type": "string" }, "reward": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } }, "description": "DelegationDelegatorReward represents the properties\nof a delegator's delegation reward." }, "cosmos.distribution.v1beta1.DelegatorStartingInfo": { "type": "object", "properties": { "previousPeriod": { "type": "string", "format": "uint64" }, "stake": { "type": "string" }, "height": { "type": "string", "format": "uint64" } }, "description": "DelegatorStartingInfo represents the starting info for a delegator reward\nperiod. It tracks the previous validator period, the delegation's amount of\nstaking token, and the creation height (to check later on if any slashes have\noccurred). NOTE: Even though validators are slashed to whole staking tokens,\nthe delegators within the validator may be left with less than a full token,\nthus sdk.Dec is used." }, "cosmos.distribution.v1beta1.Params": { "type": "object", "properties": { "communityTax": { "type": "string" }, "baseProposerReward": { "type": "string", "description": "Deprecated: The base_proposer_reward field is deprecated and is no longer used\nin the x/distribution module's reward mechanism." }, "bonusProposerReward": { "type": "string", "description": "Deprecated: The bonus_proposer_reward field is deprecated and is no longer used\nin the x/distribution module's reward mechanism." }, "withdrawAddrEnabled": { "type": "boolean" } }, "description": "Params defines the set of params for the distribution module." }, "cosmos.distribution.v1beta1.QueryCommunityPoolResponse": { "type": "object", "properties": { "pool": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." }, "description": "pool defines community pool's coins." } }, "description": "QueryCommunityPoolResponse is the response type for the Query/CommunityPool\nRPC method." }, "cosmos.distribution.v1beta1.QueryDelegationRewardsResponse": { "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." }, "description": "rewards defines the rewards accrued by a delegation." } }, "description": "QueryDelegationRewardsResponse is the response type for the\nQuery/DelegationRewards RPC method." }, "cosmos.distribution.v1beta1.QueryDelegationTotalRewardsResponse": { "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "validatorAddress": { "type": "string" }, "reward": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } }, "description": "DelegationDelegatorReward represents the properties\nof a delegator's delegation reward." }, "description": "rewards defines all the rewards accrued by a delegator." }, "total": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." }, "description": "total defines the sum of all the rewards." } }, "description": "QueryDelegationTotalRewardsResponse is the response type for the\nQuery/DelegationTotalRewards RPC method." }, "cosmos.distribution.v1beta1.QueryDelegatorStartingInfoResponse": { "type": "object", "properties": { "startingInfo": { "description": "starting_info defines the starting info of a delegator.", "type": "object", "properties": { "previousPeriod": { "type": "string", "format": "uint64" }, "stake": { "type": "string" }, "height": { "type": "string", "format": "uint64" } } } }, "description": "QueryDelegatorStartingInfoResponse is the response type for the\nQuery/DelegatorStartingInfo RPC method." }, "cosmos.distribution.v1beta1.QueryDelegatorValidatorsResponse": { "type": "object", "properties": { "validators": { "type": "array", "items": { "type": "string" }, "description": "validators defines the validators a delegator is delegating for." } }, "description": "QueryDelegatorValidatorsResponse is the response type for the\nQuery/DelegatorValidators RPC method." }, "cosmos.distribution.v1beta1.QueryDelegatorWithdrawAddressResponse": { "type": "object", "properties": { "withdrawAddress": { "type": "string", "description": "withdraw_address defines the delegator address to query for." } }, "description": "QueryDelegatorWithdrawAddressResponse is the response type for the\nQuery/DelegatorWithdrawAddress RPC method." }, "cosmos.distribution.v1beta1.QueryParamsResponse": { "type": "object", "properties": { "params": { "description": "params defines the parameters of the module.", "type": "object", "properties": { "communityTax": { "type": "string" }, "baseProposerReward": { "type": "string", "description": "Deprecated: The base_proposer_reward field is deprecated and is no longer used\nin the x/distribution module's reward mechanism." }, "bonusProposerReward": { "type": "string", "description": "Deprecated: The bonus_proposer_reward field is deprecated and is no longer used\nin the x/distribution module's reward mechanism." }, "withdrawAddrEnabled": { "type": "boolean" } } } }, "description": "QueryParamsResponse is the response type for the Query/Params RPC method." }, "cosmos.distribution.v1beta1.QueryValidatorCommissionResponse": { "type": "object", "properties": { "commission": { "description": "commission defines the commission the validator received.", "type": "object", "properties": { "commission": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } } } }, "title": "QueryValidatorCommissionResponse is the response type for the\nQuery/ValidatorCommission RPC method" }, "cosmos.distribution.v1beta1.QueryValidatorCurrentRewardsResponse": { "type": "object", "properties": { "rewards": { "description": "rewards defines the current rewards of a validator.", "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } }, "period": { "type": "string", "format": "uint64" } } } }, "description": "QueryValidatorCurrentRewardsResponse is the response type for the\nQuery/ValidatorCurrentRewards RPC method." }, "cosmos.distribution.v1beta1.QueryValidatorDistributionInfoResponse": { "type": "object", "properties": { "operatorAddress": { "type": "string", "description": "operator_address defines the validator operator address." }, "selfBondRewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." }, "description": "self_bond_rewards defines the self delegations rewards." }, "commission": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." }, "description": "commission defines the commission the validator received." } }, "description": "QueryValidatorDistributionInfoResponse is the response type for the Query/ValidatorDistributionInfo RPC method." }, "cosmos.distribution.v1beta1.QueryValidatorHistoricalRewardsResponse": { "type": "object", "properties": { "rewards": { "description": "rewards defines the historical rewards of a validator.", "type": "object", "properties": { "cumulativeRewardRatio": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } }, "referenceCount": { "type": "integer", "format": "int64" } }, "title": "ValidatorHistoricalRewards represents historical rewards for a validator.\nHeight is implicit within the store key.\nCumulative reward ratio is the sum from the zeroeth period\nuntil this period of rewards / tokens, per the spec.\nThe reference count indicates the number of objects\nwhich might need to reference this historical entry at any point.\nReferenceCount =\n number of outstanding delegations which ended the associated period (and\n might need to read that record)\n + number of slashes which ended the associated period (and might need to\n read that record)\n + one per validator for the zeroeth period, set on initialization" } }, "description": "QueryValidatorHistoricalRewardsResponse is the response type for the\nQuery/ValidatorHistoricalRewards RPC method." }, "cosmos.distribution.v1beta1.QueryValidatorOutstandingRewardsResponse": { "type": "object", "properties": { "rewards": { "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } }, "description": "ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards\nfor a validator inexpensive to track, allows simple sanity checks." } }, "description": "QueryValidatorOutstandingRewardsResponse is the response type for the\nQuery/ValidatorOutstandingRewards RPC method." }, "cosmos.distribution.v1beta1.QueryValidatorSlashesResponse": { "type": "object", "properties": { "slashes": { "type": "array", "items": { "type": "object", "properties": { "validatorPeriod": { "type": "string", "format": "uint64" }, "fraction": { "type": "string" } }, "description": "ValidatorSlashEvent represents a validator slash event.\nHeight is implicit within the store key.\nThis is needed to calculate appropriate amount of staking tokens\nfor delegations which are withdrawn after a slash has occurred." }, "description": "slashes defines the slashes the validator received." }, "pagination": { "description": "pagination defines the pagination in the response.", "type": "object", "properties": { "nextKey": { "type": "string", "format": "byte", "description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results." }, "total": { "type": "string", "format": "uint64", "title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise" } } } }, "description": "QueryValidatorSlashesResponse is the response type for the\nQuery/ValidatorSlashes RPC method." }, "cosmos.distribution.v1beta1.ValidatorAccumulatedCommission": { "type": "object", "properties": { "commission": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } }, "description": "ValidatorAccumulatedCommission represents accumulated commission\nfor a validator kept as a running counter, can be withdrawn at any time." }, "cosmos.distribution.v1beta1.ValidatorCurrentRewards": { "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } }, "period": { "type": "string", "format": "uint64" } }, "description": "ValidatorCurrentRewards represents current rewards and current\nperiod for a validator kept as a running counter and incremented\neach block as long as the validator's tokens remain constant." }, "cosmos.distribution.v1beta1.ValidatorHistoricalRewards": { "type": "object", "properties": { "cumulativeRewardRatio": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } }, "referenceCount": { "type": "integer", "format": "int64" } }, "title": "ValidatorHistoricalRewards represents historical rewards for a validator.\nHeight is implicit within the store key.\nCumulative reward ratio is the sum from the zeroeth period\nuntil this period of rewards / tokens, per the spec.\nThe reference count indicates the number of objects\nwhich might need to reference this historical entry at any point.\nReferenceCount =\n number of outstanding delegations which ended the associated period (and\n might need to read that record)\n + number of slashes which ended the associated period (and might need to\n read that record)\n + one per validator for the zeroeth period, set on initialization" }, "cosmos.distribution.v1beta1.ValidatorOutstandingRewards": { "type": "object", "properties": { "rewards": { "type": "array", "items": { "type": "object", "properties": { "denom": { "type": "string" }, "amount": { "type": "string" } }, "description": "DecCoin defines a token with a denomination and a decimal amount.\n\nNOTE: The amount field is a Dec which implements the custom method\nsignatures required by gogoproto." } } }, "description": "ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards\nfor a validator inexpensive to track, allows simple sanity checks." }, "cosmos.distribution.v1beta1.ValidatorSlashEvent": { "type": "object", "properties": { "validatorPeriod": { "type": "string", "format": "uint64" }, "fraction": { "type": "string" } }, "description": "ValidatorSlashEvent represents a validator slash event.\nHeight is implicit within the store key.\nThis is needed to calculate appropriate amount of staking tokens\nfor delegations which are withdrawn after a slash has occurred." } } }