Skip to main content
Version: 0.1.0

Protocol Documentation

Table of Contents​

Top

centerchain/income/v1/query.proto​

QueryAccountStreamRequest​

FieldTypeLabelDescription
addressstring
eligibility_denomstring
reward_denomstring

QueryAccountStreamResponse​

FieldTypeLabelDescription
streamAccountStreamstream is settled against the stored accumulator so pending includes un-accrued rewards.

QueryAllStreamsRequest​

FieldTypeLabelDescription
paginationcosmos.base.query.v1beta1.PageRequest

QueryAllStreamsResponse​

FieldTypeLabelDescription
streamsStreamrepeated
paginationcosmos.base.query.v1beta1.PageResponse

QueryClaimableRequest​

FieldTypeLabelDescription
addressstring

QueryClaimableResponse​

FieldTypeLabelDescription
amountscosmos.base.v1beta1.Coinrepeated
nft_claimablesNFTClaimablerepeated

QueryIncomeConfigRequest​

FieldTypeLabelDescription
denomstring

QueryIncomeConfigResponse​

FieldTypeLabelDescription
configIncomeConfig

QueryParamsRequest​

QueryParamsResponse​

FieldTypeLabelDescription
paramsParams

QueryStatsRequest​

FieldTypeLabelDescription
denomstringdenom is the eligibility denom whose streams are aggregated.

QueryStatsResponse​

FieldTypeLabelDescription
supplystringsupply is the bank supply of the eligibility denom at query time.
total_distributedstringtotal_distributed is the sum of stream total_distributed for this eligibility denom.
stream_countuint64stream_count is the number of streams for this eligibility denom.

Query​

Method NameRequest TypeResponse TypeDescription
ParamsQueryParamsRequestQueryParamsResponse
IncomeConfigQueryIncomeConfigRequestQueryIncomeConfigResponse
AccountStreamQueryAccountStreamRequestQueryAccountStreamResponse
ClaimableQueryClaimableRequestQueryClaimableResponse
AllStreamsQueryAllStreamsRequestQueryAllStreamsResponse
StatsQueryStatsRequestQueryStatsResponse

Scalar Value Types​

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)