SuiJSON is a JSON-based format with restrictions that allow Sui to align JSON inputs more closely with Move Call arguments.
This table shows the restrictions placed on JSON types to make them SuiJSON compatible:
|JSON||SuiJSON Restrictions||Move Type Mapping|
|Number||Must be unsigned integer||U8
(U128 is encoded as String)
Unsigned Integer (128 bit max)
|Array||Must be homogeneous JSON and of SuiJSON type||Vector|
Type coercion reasoning
Due to the loosely typed nature of JSON/SuiJSON and the strongly typed nature of Move types, we sometimes need to overload SuiJSON types to represent multiple Move types.
SuiJSON::Number can represent both U8 and U64. This means we have to coerce and sometimes convert types.
Which type we coerce depends on the expected Move type. For example, if the Move function expects a U8, we must have received a
SuiJSON::Number with a value less than 256. More importantly, we have no way to easily express Move addresses in JSON, so we encode them as hex strings prefixed by
Additionally, Move supports U128 but JSON doesn't. As a result we allow encoding numbers as strings.
Type coercion rules
|Move Type||SuiJSON Representations||Valid Examples||Invalid Examples|
Three formats are supported
Similarly to U8, three formats are supported
||Extrapolate above examples||Extrapolate above examples|
Two formats are supported
|Address||20 byte hex string prefixed with
|ObjectID||16 byte hex string prefixed with
||Similar to above|
|Identifier||Typically used for module and function names. Encoded as one of the following:
|Vector<Move Type>||Homogeneous vector of aforementioned types including nested vectors||
|Vector<U8>||For convenience, we allow:
U8 vectors represented as UTF-8 (and ASCII) strings.