Protocol Documentation

Table of Contents

• centerchain/income/v1/tx.proto

  • MsgClaimRewards

  • MsgClaimRewardsResponse

  • MsgDistribute

  • MsgDistributeResponse

  • MsgPushNFTClaimable

  • MsgPushNFTClaimableResponse

  • MsgSetIncome

  • MsgSetIncomeResponse

  • MsgUpdateParams

  • MsgUpdateParamsResponse

  • Msg

• Scalar Value Types

Top

centerchain/income/v1/tx.proto

MsgClaimRewards

Field	Type	Label	Description
sender	string
eligibility_denom	string		Optional shared filters for fungible streams and NFT claimables. For NFTs, eligibility_denom matches class_id; empty means all eligible claims. A restricted selected NFT claim rejects the whole MsgClaimRewards atomically.
reward_denom	string		For NFTs, reward_denom matches the claimable payout denom; empty means all.
max_nft_claims	uint64		0 uses Params.max_nft_claims.

MsgClaimRewardsResponse

Field	Type	Label	Description
fungible_claimed	cosmos.base.v1beta1.Coin	repeated
nft_claims_paid	uint64

MsgDistribute

Field	Type	Label	Description
sender	string
eligibility_denom	string
reward_denom	string
amount	cosmos.base.v1beta1.Coin

MsgDistributeResponse

MsgPushNFTClaimable

Field	Type	Label	Description
sender	string
class_id	string
token_id	string
reward_denom	string
amount	cosmos.base.v1beta1.Coin

MsgPushNFTClaimableResponse

MsgSetIncome

Field	Type	Label	Description
authority	string		authority is the signer: tokenfactory denom admin, income admin, or module authority.
denom	string		denom is the eligibility bank denom or NFT class id.
yield_address	string		yield_address empty defaults to the income module yield account.
has_income	bool

MsgSetIncomeResponse

MsgUpdateParams

Field	Type	Label	Description
authority	string
params	Params

MsgUpdateParamsResponse

Msg

Method Name	Request Type	Response Type	Description
SetIncome	MsgSetIncome	MsgSetIncomeResponse	SetIncome registers or updates the income configuration for an eligibility denom or NFT class id (yield address + has_income flag).
Distribute	MsgDistribute	MsgDistributeResponse	Distribute moves reward tokens from the sender into the yield account and bumps the reward-per-share accumulator for the eligibility stream.
ClaimRewards	MsgClaimRewards	MsgClaimRewardsResponse	ClaimRewards settles and pays fungible claimables plus an NFT claim batch.
PushNFTClaimable	MsgPushNFTClaimable	MsgPushNFTClaimableResponse	PushNFTClaimable funds the yield account and earmarks an NFT claimable.
UpdateParams	MsgUpdateParams	MsgUpdateParamsResponse	UpdateParams updates module parameters (governance authority).

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)