Protocol Documentation

Table of Contents

• centerchain/tokenfactory/v1/tx.proto

  • MsgAddBlacklist

  • MsgAddBlacklistResponse

  • MsgAddDelegate

  • MsgAddDelegateResponse

  • MsgBurn

  • MsgBurnResponse

  • MsgChangeAdmin

  • MsgChangeAdminResponse

  • MsgCreateDenom

  • MsgCreateDenomResponse

  • MsgForceTransfer

  • MsgForceTransferResponse

  • MsgMint

  • MsgMintResponse

  • MsgRemoveBlacklist

  • MsgRemoveBlacklistResponse

  • MsgRemoveDelegate

  • MsgRemoveDelegateResponse

  • MsgSetDenomMetadata

  • MsgSetDenomMetadataResponse

  • MsgSetDenomRestriction

  • MsgSetDenomRestrictionResponse

  • MsgSetPoolDenylist

  • MsgSetPoolDenylistResponse

  • MsgSetPoolable

  • MsgSetPoolableResponse

  • MsgUpdateParams

  • MsgUpdateParamsResponse

  • Msg

• Scalar Value Types

Top

centerchain/tokenfactory/v1/tx.proto

MsgAddBlacklist

Field	Type	Label	Description
sender	string
denom	string
address	string

MsgAddBlacklistResponse

MsgAddDelegate

Field	Type	Label	Description
sender	string
denom	string
address	string

MsgAddDelegateResponse

MsgBurn

MsgBurn is the sdk.Msg type for allowing an admin account to burn a token. For now, we only support burning from the sender account.

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

MsgBurnResponse

MsgChangeAdmin

MsgChangeAdmin is the sdk.Msg type for allowing an admin account to reassign adminship of a denom to a new account

Field	Type	Label	Description
sender	string
denom	string
new_admin	string

MsgChangeAdminResponse

MsgChangeAdminResponse defines the response structure for an executed MsgChangeAdmin message.

MsgCreateDenom

MsgCreateDenom defines the message structure for the CreateDenom gRPC service method. It allows an account to create a new denom. It requires a sender address and a sub denomination. The (sender_address, sub_denomination) tuple must be unique and cannot be re-used.

The resulting denom created is defined as <factory/{creatorAddress}/{subdenom}>. The resulting denom's admin is originally set to be the creator, but this can be changed later. The token denom does not indicate the current admin.

Field	Type	Label	Description
sender	string
subdenom	string		subdenom can be up to 44 "alphanumeric" characters long.

MsgCreateDenomResponse

MsgCreateDenomResponse is the return value of MsgCreateDenom It returns the full string of the newly created denom

Field	Type	Label	Description
new_token_denom	string

MsgForceTransfer

Field	Type	Label	Description
sender	string
amount	cosmos.base.v1beta1.Coin
transferFromAddress	string
transferToAddress	string

MsgForceTransferResponse

MsgMint

MsgMint is the sdk.Msg type for allowing an admin account to mint more of a token. For now, we only support minting to the sender account

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

MsgMintResponse

MsgRemoveBlacklist

Field	Type	Label	Description
sender	string
denom	string
address	string

MsgRemoveBlacklistResponse

MsgRemoveDelegate

Field	Type	Label	Description
sender	string
denom	string
address	string

MsgRemoveDelegateResponse

MsgSetDenomMetadata

MsgSetDenomMetadata is the sdk.Msg type for allowing an admin account to set the denom's bank metadata

Field	Type	Label	Description
sender	string
metadata	cosmos.bank.v1beta1.Metadata

MsgSetDenomMetadataResponse

MsgSetDenomMetadataResponse defines the response structure for an executed MsgSetDenomMetadata message.

MsgSetDenomRestriction

Field	Type	Label	Description
sender	string
denom	string		subdenom can be up to 44 "alphanumeric" characters long.
isRestricted	bool

MsgSetDenomRestrictionResponse

MsgSetPoolDenylist

Field	Type	Label	Description
authority	string		authority is the configured tokenfactory governance authority.
denom	string
denylisted	bool

MsgSetPoolDenylistResponse

MsgSetPoolable

Field	Type	Label	Description
sender	string
denom	string
poolable	bool

MsgSetPoolableResponse

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
authority	string		authority is the address of the governance account.
params	Params		params defines the x/mint parameters to update.

NOTE: All parameters must be supplied. |

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.

Since: cosmos-sdk 0.47

Msg

Msg defines the tokefactory module's gRPC message service.

Method Name	Request Type	Response Type	Description
CreateDenom	MsgCreateDenom	MsgCreateDenomResponse
Mint	MsgMint	MsgMintResponse
Burn	MsgBurn	MsgBurnResponse
ChangeAdmin	MsgChangeAdmin	MsgChangeAdminResponse
SetDenomMetadata	MsgSetDenomMetadata	MsgSetDenomMetadataResponse
ForceTransfer	MsgForceTransfer	MsgForceTransferResponse
AddDelegate	MsgAddDelegate	MsgAddDelegateResponse
RemoveDelegate	MsgRemoveDelegate	MsgRemoveDelegateResponse
AddBlacklist	MsgAddBlacklist	MsgAddBlacklistResponse
RemoveBlacklist	MsgRemoveBlacklist	MsgRemoveBlacklistResponse
SetDenomRestriction	MsgSetDenomRestriction	MsgSetDenomRestrictionResponse
SetPoolable	MsgSetPoolable	MsgSetPoolableResponse
SetPoolDenylist	MsgSetPoolDenylist	MsgSetPoolDenylistResponse
UpdateParams	MsgUpdateParams	MsgUpdateParamsResponse	UpdateParams defines a governance operation for updating the x/mint module parameters. The authority is hard-coded to the x/gov module account.

Since: cosmos-sdk 0.47 |

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)