Protocol Documentation

Table of Contents

• centerchain/income/v1/genesis.proto

  • AccountStream
  • GenesisState
  • IncomeConfig
  • NFTClaimable
  • Stream

• Scalar Value Types

Top

centerchain/income/v1/genesis.proto

AccountStream

AccountStream is a holder's checkpoint into a stream.

Field	Type	Label	Description
address	string
eligibility_denom	string
reward_denom	string
reward_index	string		reward_index is the stream index at the last settle.
pending	string		pending is the claimable reward accrued but not yet paid.
last_update	int64

GenesisState

Field	Type	Label	Description
params	Params
income_configs	IncomeConfig	repeated
streams	Stream	repeated
account_streams	AccountStream	repeated
nft_claimables	NFTClaimable	repeated

IncomeConfig

IncomeConfig is the per-denom (or per class id) income configuration.

Field	Type	Label	Description
denom	string		denom is the eligibility bank denom or NFT class id.
yield_address	string		yield_address is the bank account that receives distribute/push funding.
has_income	bool
distributed_total	string		distributed_total is the cumulative amount distributed for this eligibility denom.

NFTClaimable

NFTClaimable is an earmarked reward attached to one NFT token.

Field	Type	Label	Description
class_id	string
token_id	string
reward_denom	string
amount	string		amount is the remaining claimable balance (0 after claim).
status	string		status is "active" or "claimed".

Stream

Stream is the global reward-per-share accumulator for one eligibility/reward pair.

Field	Type	Label	Description
eligibility_denom	string
reward_denom	string
index	string		index is the reward-per-share accumulator, scaled by 10^18.
total_distributed	string		total_distributed is the cumulative reward deposited into this stream.
last_update	int64

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)