Protocol Documentation

Table of Contents

• centerchain/tokenfactory/v1/tx.proto

  • MsgAddBlacklist

  • MsgAddBlacklistResponse

  • MsgAddDelegate

  • MsgAddDelegateResponse

  • MsgBurn

  • MsgBurnResponse

  • MsgChangeAdmin

  • MsgChangeAdminResponse

  • MsgClaimMint

  • MsgClaimMintNFT

  • MsgClaimMintNFTResponse

  • MsgClaimMintResponse

  • MsgClaimSend

  • MsgClaimSendNFT

  • MsgClaimSendNFTResponse

  • MsgClaimSendResponse

  • MsgCreateAuthorization

  • MsgCreateDenom

  • MsgCreateDenomResponse

  • MsgExecuteBurn

  • MsgExecuteMint

  • MsgExecutePull

  • MsgExecuteSend

  • MsgExecuteSwap

  • MsgForceTransfer

  • MsgForceTransferResponse

  • MsgMint

  • MsgMintResponse

  • MsgRemoveBlacklist

  • MsgRemoveBlacklistResponse

  • MsgRemoveDelegate

  • MsgRemoveDelegateResponse

  • MsgRevokeAuthorization

  • MsgRevokeClaim

  • MsgRevokeClaimResponse

  • MsgSetDenomMetadata

  • MsgSetDenomMetadataResponse

  • MsgSetDenomRestriction

  • MsgSetDenomRestrictionResponse

  • MsgSetPoolDenylist

  • MsgSetPoolDenylistResponse

  • MsgSetPoolable

  • MsgSetPoolableResponse

  • MsgSetSwapConfig

  • MsgUpdateParams

  • MsgUpdateParamsResponse

  • NFTScope

  • SwapConfig

  • SwapResponse

  • AuthorizationKind

  • 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.

MsgClaimMint

MsgClaimMint mints new supply to mint_to on behalf of the denom owner. The owner is the signing authority: their pubkey must hash to owner and the signature must cover every field except executor and signature. The executor is only the courier that submits the message and pays the tx fee.

Field	Type	Label	Description
executor	string
owner	string		owner is the denom admin/issuer whose signature authorizes the mint.
denom	string
amount	string		amount is the canonical integer string.
mint_to	string
nonce	bytes		nonce is the 128-bit single-use value chosen by the signer.
chain_id	string
expiry_height	uint64		expiry_height is the absolute block height after which the permit is void.
pubkey	bytes		pubkey is the signer's secp256k1 compressed public key.
signature	bytes		signature is the secp256k1 signature over the claim payload.

MsgClaimMintNFT

MsgClaimMintNFT mints a certificate into to on behalf of the class issuer. The class issuer is the signing authority: their pubkey must hash to issuer and the signature must cover every field except executor and signature. The executor is only the courier that pays the tx fee.

Field	Type	Label	Description
executor	string
issuer	string		issuer is the class issuer whose signature authorizes the mint.
class_id	string
to	string
uri	string
uri_hash	string
nonce	bytes		nonce is the 128-bit single-use value chosen by the signer.
chain_id	string
expiry_height	uint64		expiry_height is the absolute block height after which the permit is void.
pubkey	bytes		pubkey is the signer's secp256k1 compressed public key.
signature	bytes		signature is the secp256k1 signature over the claim payload.

MsgClaimMintNFTResponse

Field	Type	Label	Description
token_id	string		token_id is the minted certificate id.

MsgClaimMintResponse

MsgClaimSend

MsgClaimSend sends tokens from the balance holder from to to on behalf of the holder. The holder is the signing authority: their pubkey must hash to from and the signature must cover every field except executor and signature.

Field	Type	Label	Description
executor	string
from	string		from is the balance holder whose signature authorizes the send.
denom	string
amount	string		amount is the canonical integer string.
to	string
nonce	bytes		nonce is the 128-bit single-use value chosen by the signer.
chain_id	string
expiry_height	uint64		expiry_height is the absolute block height after which the permit is void.
pubkey	bytes		pubkey is the signer's secp256k1 compressed public key.
signature	bytes		signature is the secp256k1 signature over the claim payload.

MsgClaimSendNFT

MsgClaimSendNFT sends a certificate from the current holder from to to. The holder's own signature is the consent; the executor submits the signed message and pays the tx fee. Lock, blocklist and class policy checks are re-applied by the handler.

Field	Type	Label	Description
executor	string
from	string		from is the certificate holder whose signature authorizes the send.
class_id	string
token_id	string
to	string
nonce	bytes		nonce is the 128-bit single-use value chosen by the signer.
chain_id	string
expiry_height	uint64		expiry_height is the absolute block height after which the permit is void.
pubkey	bytes		pubkey is the signer's secp256k1 compressed public key.
signature	bytes		signature is the secp256k1 signature over the claim payload.

MsgClaimSendNFTResponse

MsgClaimSendResponse

MsgCreateAuthorization

Field	Type	Label	Description
holder	string
order_seq	uint64
chain_id	string
executor	string
from_denom	string
to_denom	string
to_amount	string
max_from	string
from_nft	NFTScope
to_nft	NFTScope
kind	AuthorizationKind
max_fee	string
valid_blocks	uint64		valid_blocks is the holder-supplied relative lifetime in blocks. Zero resolves to params.default_authorization_blocks at creation time.

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

MsgExecuteBurn

MsgExecuteBurn executes the input leg of a kind=BURN authorization: the fungible amount (or the single locked NFT) is moved into the module account and burned. There is no output leg and no gas field. Only the denom admin (fungible input) or the class issuer (NFT input) may execute it.

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
amount	string

MsgExecuteMint

MsgExecuteMint carries a separate, signer-authorized action permit. The referenced TX1 authorization only pays this transaction's gas and carries no mint terms. holder is the gas payer; executor is the denom admin signing the action and the tx signer.

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
denom	string
amount	string
mint_to	string
nonce	bytes
expiry_height	uint64
pubkey	bytes
signature	bytes

MsgExecutePull

MsgExecutePull executes the input leg only: the amount is escrowed from the holder into the module account (never burned). There is no output leg and no gas field. It consumes a kind=PULL authorization.

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
amount	string

MsgExecuteSend

MsgExecuteSend carries a separate, signer-authorized action permit. The referenced TX1 authorization only pays this transaction's gas and carries no send terms. holder is the gas payer; executor is the balance holder signing the action and the tx signer.

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
denom	string
amount	string
to	string
nonce	bytes
expiry_height	uint64
pubkey	bytes
signature	bytes

MsgExecuteSwap

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
used_from	string
to_amount	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

MsgRevokeAuthorization

Field	Type	Label	Description
holder	string
order_seq	uint64
chain_id	string

MsgRevokeClaim

MsgRevokeClaim invalidates a single permit nonce before it is spent. The message is a normal tx signed by signer; there is no permit signature because the tx signature is the authorization.

Field	Type	Label	Description
signer	string
nonce	bytes		nonce is the 128-bit permit nonce to revoke.

MsgRevokeClaimResponse

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

MsgSetSwapConfig

Field	Type	Label	Description
authority	string
config	SwapConfig

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

NFTScope

Field	Type	Label	Description
class_id	string
token_id	string

SwapConfig

SwapResponse

AuthorizationKind

AuthorizationKind binds a two-phase authorization to exactly one consuming message. MINT and SEND kinds authorize TX2 gas only; their action permits are signed and verified separately.

Name	Number	Description
AUTHORIZATION_KIND_UNSPECIFIED	0
AUTHORIZATION_KIND_SWAP	1
AUTHORIZATION_KIND_PULL	2
AUTHORIZATION_KIND_BURN	3
AUTHORIZATION_KIND_MINT	4
AUTHORIZATION_KIND_SEND	5

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
CreateAuthorization	MsgCreateAuthorization	SwapResponse	Two-phase authorization execution.
ExecuteSwap	MsgExecuteSwap	SwapResponse
ExecutePull	MsgExecutePull	SwapResponse
ExecuteBurn	MsgExecuteBurn	SwapResponse
ExecuteMint	MsgExecuteMint	SwapResponse
ExecuteSend	MsgExecuteSend	SwapResponse
RevokeAuthorization	MsgRevokeAuthorization	SwapResponse
SetSwapConfig	MsgSetSwapConfig	SwapResponse
ClaimMint	MsgClaimMint	MsgClaimMintResponse	Single-transaction permit messages.
ClaimSend	MsgClaimSend	MsgClaimSendResponse
ClaimMintNFT	MsgClaimMintNFT	MsgClaimMintNFTResponse
ClaimSendNFT	MsgClaimSendNFT	MsgClaimSendNFTResponse
RevokeClaim	MsgRevokeClaim	MsgRevokeClaimResponse
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)