Protocol Documentation

Table of Contents

• centerchain/tokenfactory/v1/swap.proto

  • Authorization

  • MsgCreateAuthorization

  • MsgExecuteBurn

  • MsgExecutePull

  • MsgExecuteSwap

  • MsgRevokeAuthorization

  • MsgSetSwapConfig

  • NFTScope

  • QueryAuthorizationRequest

  • QueryAuthorizationResponse

  • QueryAuthorizationsRequest

  • QueryAuthorizationsResponse

  • QueryHighWaterMarkRequest

  • QueryHighWaterMarkResponse

  • SwapConfig

  • SwapGenesis

  • SwapHighWaterMark

  • SwapResponse

  • AuthorizationKind

  • SwapMsg

  • SwapQuery

• Scalar Value Types

Top

centerchain/tokenfactory/v1/swap.proto

Authorization

Field	Type	Label	Description
terms	MsgCreateAuthorization
consumed	bool
revoked	bool
used_from	string
gas_fee	string

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
gas_fee_max	string
from_nft	NFTScope
to_nft	NFTScope
kind	AuthorizationKind

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

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

MsgExecuteSwap

Field	Type	Label	Description
executor	string
holder	string
order_seq	uint64
chain_id	string
used_from	string
to_amount	string
gas_fee	string

MsgRevokeAuthorization

Field	Type	Label	Description
holder	string
order_seq	uint64
chain_id	string

MsgSetSwapConfig

Field	Type	Label	Description
authority	string
config	SwapConfig

NFTScope

Field	Type	Label	Description
class_id	string
token_id	string

QueryAuthorizationRequest

Field	Type	Label	Description
holder	string
order_seq	uint64

QueryAuthorizationResponse

Field	Type	Label	Description
authorization	Authorization
high_water_mark	uint64
reserved_from	string
gas_mode	string

QueryAuthorizationsRequest

QueryAuthorizationsRequest lists every authorization created by a holder, newest sequence last. Consumed and revoked authorizations are included.

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

QueryAuthorizationsResponse

Field	Type	Label	Description
authorizations	Authorization	repeated
pagination	cosmos.base.query.v1beta1.PageResponse

QueryHighWaterMarkRequest

Field	Type	Label	Description
holder	string

QueryHighWaterMarkResponse

Field	Type	Label	Description
sequence	uint64

SwapConfig

Field	Type	Label	Description
technical_issuer	string
executors	string	repeated

SwapGenesis

Field	Type	Label	Description
config	SwapConfig
authorizations	Authorization	repeated
high_water_marks	SwapHighWaterMark	repeated

SwapHighWaterMark

Field	Type	Label	Description
holder	string
sequence	uint64

SwapResponse

AuthorizationKind

AuthorizationKind is the purpose binding of a two-phase authorization. The kind decides which consuming message is allowed to spend it, so a swap authorization can never be reduced to a single-leg pull or burn and vice versa.

Name	Number	Description
AUTHORIZATION_KIND_UNSPECIFIED	0
AUTHORIZATION_KIND_SWAP	1
AUTHORIZATION_KIND_PULL	2
AUTHORIZATION_KIND_BURN	3

SwapMsg

Method Name	Request Type	Response Type	Description
CreateAuthorization	MsgCreateAuthorization	SwapResponse
ExecuteSwap	MsgExecuteSwap	SwapResponse
ExecutePull	MsgExecutePull	SwapResponse
ExecuteBurn	MsgExecuteBurn	SwapResponse
RevokeAuthorization	MsgRevokeAuthorization	SwapResponse
SetSwapConfig	MsgSetSwapConfig	SwapResponse

SwapQuery

Method Name	Request Type	Response Type	Description
Authorization	QueryAuthorizationRequest	QueryAuthorizationResponse
Authorizations	QueryAuthorizationsRequest	QueryAuthorizationsResponse
HighWaterMark	QueryHighWaterMarkRequest	QueryHighWaterMarkResponse

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)