Protocol Documentation

Table of Contents

• centerchain/nft/v1/nft.proto

  • ClassData

  • ClassMeta

  • ClassSequence

  • GenesisState

  • MsgBurnNFT

  • MsgBurnNFTResponse

  • MsgChangeClassIssuer

  • MsgChangeClassIssuerResponse

  • MsgCreateClass

  • MsgCreateClassResponse

  • MsgMintNFT

  • MsgMintNFTResponse

  • MsgSetNFTMetadata

  • MsgSetNFTMetadataResponse

  • NFTData

  • NFTLock

  • Params

  • QueryClassDetailRequest

  • QueryClassDetailResponse

  • QueryClassIssuerRequest

  • QueryClassIssuerResponse

  • QueryClassesByIssuerRequest

  • QueryClassesByIssuerResponse

  • QueryNFTLockRequest

  • QueryNFTLockResponse

  • QueryParamsRequest

  • QueryParamsResponse

  • QueryTokensByClassRequest

  • QueryTokensByClassResponse

  • QueryTokensByOwnerRequest

  • QueryTokensByOwnerResponse

  • TokenSummary

  • Msg

  • Query

• Scalar Value Types

Top

centerchain/nft/v1/nft.proto

ClassData

Field	Type	Label	Description
product_ref	string

ClassMeta

Field	Type	Label	Description
class_id	string
issuer	string
product_ref	string
restricted	bool
token_metadata_immutable	bool

ClassSequence

Field	Type	Label	Description
class_id	string
sequence	uint64

GenesisState

Field	Type	Label	Description
params	Params
classes	ClassMeta	repeated
sequences	ClassSequence	repeated
locks	NFTLock	repeated

MsgBurnNFT

Field	Type	Label	Description
sender	string
class_id	string
token_id	string

MsgBurnNFTResponse

MsgChangeClassIssuer

Field	Type	Label	Description
authority	string
class_id	string
new_issuer	string

MsgChangeClassIssuerResponse

MsgCreateClass

Field	Type	Label	Description
sender	string
class_id	string
name	string
symbol	string
description	string
uri	string
uri_hash	string
restricted	bool
token_metadata_immutable	bool

MsgCreateClassResponse

MsgMintNFT

Field	Type	Label	Description
sender	string
class_id	string
to	string
uri	string
uri_hash	string

MsgMintNFTResponse

Field	Type	Label	Description
token_id	string

MsgSetNFTMetadata

Field	Type	Label	Description
sender	string
class_id	string
token_id	string
uri	string
uri_hash	string

MsgSetNFTMetadataResponse

NFTData

Field	Type	Label	Description
product_ref	string

NFTLock

Field	Type	Label	Description
class_id	string
token_id	string
order_id	string
holder	string

Params

Field	Type	Label	Description
class_creation_fee	cosmos.base.v1beta1.Coin	repeated
class_creation_gas_consume	uint64

QueryClassDetailRequest

Field	Type	Label	Description
class_id	string
pagination	cosmos.base.query.v1beta1.PageRequest

QueryClassDetailResponse

Field	Type	Label	Description
class	ClassMeta
total_supply	uint64
holder_count	uint64		DEPRECATED: no longer computed on-chain. It previously required an unbounded scan of every token in the class and is now always 0. Use the paginated tokens / TokensByClass, or an off-chain indexer, for holder counts. Field number is preserved for wire compatibility.
tokens	TokenSummary	repeated
pagination	cosmos.base.query.v1beta1.PageResponse

QueryClassIssuerRequest

Field	Type	Label	Description
class_id	string

QueryClassIssuerResponse

Field	Type	Label	Description
class	ClassMeta

QueryClassesByIssuerRequest

Field	Type	Label	Description
issuer	string
pagination	cosmos.base.query.v1beta1.PageRequest

QueryClassesByIssuerResponse

Field	Type	Label	Description
classes	ClassMeta	repeated
pagination	cosmos.base.query.v1beta1.PageResponse

QueryNFTLockRequest

Field	Type	Label	Description
class_id	string
token_id	string

QueryNFTLockResponse

Field	Type	Label	Description
locked	bool
lock	NFTLock

QueryParamsRequest

QueryParamsResponse

Field	Type	Label	Description
params	Params

QueryTokensByClassRequest

Field	Type	Label	Description
class_id	string
pagination	cosmos.base.query.v1beta1.PageRequest

QueryTokensByClassResponse

Field	Type	Label	Description
tokens	TokenSummary	repeated
pagination	cosmos.base.query.v1beta1.PageResponse

QueryTokensByOwnerRequest

Field	Type	Label	Description
owner	string
pagination	cosmos.base.query.v1beta1.PageRequest

QueryTokensByOwnerResponse

Field	Type	Label	Description
tokens	TokenSummary	repeated
pagination	cosmos.base.query.v1beta1.PageResponse

TokenSummary

Field	Type	Label	Description
class_id	string
token_id	string
owner	string
uri	string
uri_hash	string

Msg

Method Name	Request Type	Response Type	Description
CreateClass	MsgCreateClass	MsgCreateClassResponse
MintNFT	MsgMintNFT	MsgMintNFTResponse
BurnNFT	MsgBurnNFT	MsgBurnNFTResponse
SetNFTMetadata	MsgSetNFTMetadata	MsgSetNFTMetadataResponse
ChangeClassIssuer	MsgChangeClassIssuer	MsgChangeClassIssuerResponse

Query

Method Name	Request Type	Response Type	Description
Params	QueryParamsRequest	QueryParamsResponse
ClassIssuer	QueryClassIssuerRequest	QueryClassIssuerResponse	class_id can contain '/', so every query binds class_id (and other identifiers) as a query parameter instead of a path segment.
NFTLock	QueryNFTLockRequest	QueryNFTLockResponse
ClassesByIssuer	QueryClassesByIssuerRequest	QueryClassesByIssuerResponse
TokensByClass	QueryTokensByClassRequest	QueryTokensByClassResponse
TokensByOwner	QueryTokensByOwnerRequest	QueryTokensByOwnerResponse
ClassDetail	QueryClassDetailRequest	QueryClassDetailResponse

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)