🍣 SushiSwap Token List Registry Schema

Schema for lists of tokens compatible with the SushiSwap Interface

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	Yes	Unknown status	No	Forbidden	Forbidden	none	tokenlist.schema.json

SushiSwap Token List Type

object (SushiSwap Token List)

SushiSwap Token List Properties

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	SushiSwap Token List
timestamp	string	Required	cannot be null	SushiSwap Token List
version	object	Required	cannot be null	SushiSwap Token List
tokens	array	Required	cannot be null	SushiSwap Token List
keywords	array	Optional	cannot be null	SushiSwap Token List
tags	object	Optional	cannot be null	SushiSwap Token List
logoURI	string	Optional	cannot be null	SushiSwap Token List

Token List Name

The name of the token list

name

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 20

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[\w ]+$

try pattern

name Examples

"My Token List"

timestamp

The timestamp of this list version; i.e. when this immutable version of the list was created

timestamp

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

timestamp Type

string

timestamp Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

version

The version of the list, used in change detection

version

• is required

• Type: object (Details)

• cannot be null

• defined in: SushiSwap Token List

version Type

object (Details)

version Examples

{
  "major": 1,
  "minor": 0,
  "patch": 0
}

tokens

The list of tokens included in the list

tokens

• is required

• Type: object[] (Details)

• cannot be null

• defined in: SushiSwap Token List

tokens Type

object[] (Details)

tokens Constraints

maximum number of items: the maximum number of items for this array is: 10000

minimum number of items: the minimum number of items for this array is: 1

keywords

Keywords associated with the contents of the list; may be used in list discoverability

keywords

• is optional

• Type: string[]

• cannot be null

• defined in: SushiSwap Token List

keywords Type

string[]

keywords Constraints

maximum number of items: the maximum number of items for this array is: 20

unique items: all items in this array must be unique. Duplicates are not allowed.

tags

A mapping of tag identifiers to their name and description

tags

• is optional

• Type: object (Details)

• cannot be null

• defined in: SushiSwap Token List

tags Type

object (Details)

tags Constraints

maximum number of properties: the maximum number of properties for this object is: 20

tags Examples

{
  "stablecoin": {
    "name": "Stablecoin",
    "description": "A token with value pegged to another asset"
  }
}

logoURI

A URI for the logo of the token list; prefer SVG or PNG of size 256x256

logoURI

• is optional

• Type: string

• cannot be null

• defined in: SushiSwap Token List

logoURI Type

string

logoURI Constraints

URI: the string must be a URI, according to RFC 3986

logoURI Examples

"ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"

SushiSwap Token List Definitions

Definitions group Version

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/Version" }

Property	Type	Required	Nullable	Defined by
major	integer	Required	cannot be null	SushiSwap Token List
minor	integer	Required	cannot be null	SushiSwap Token List
patch	integer	Required	cannot be null	SushiSwap Token List

major

The major version of the list. Must be incremented when tokens are removed from the list or token addresses are changed.

major

• is required

• Type: integer

• cannot be null

• defined in: SushiSwap Token List

major Type

integer

major Constraints

minimum: the value of this number must greater than or equal to: 0

major Examples

1

2

minor

The minor version of the list. Must be incremented when tokens are added to the list.

minor

• is required

• Type: integer

• cannot be null

• defined in: SushiSwap Token List

minor Type

integer

minor Constraints

minimum: the value of this number must greater than or equal to: 0

minor Examples

0

1

patch

The patch version of the list. Must be incremented for any changes to the list.

patch

• is required

• Type: integer

• cannot be null

• defined in: SushiSwap Token List

patch Type

integer

patch Constraints

minimum: the value of this number must greater than or equal to: 0

patch Examples

0

1

Definitions group TagIdentifier

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/TagIdentifier" }

Property	Type	Required	Nullable	Defined by

Definitions group ExtensionIdentifier

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/ExtensionIdentifier" }

Property	Type	Required	Nullable	Defined by

Definitions group ExtensionValue

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/ExtensionValue" }

Property	Type	Required	Nullable	Defined by

Definitions group TagDefinition

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/TagDefinition" }

Property	Type	Required	Nullable	Defined by
name	string	Required	cannot be null	SushiSwap Token List
description	string	Required	cannot be null	SushiSwap Token List

name

The name of the tag

name

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 20

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[ \w]+$

try pattern

description

A user-friendly description of the tag

description

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

description Type

string

description Constraints

maximum length: the maximum number of characters for this string is: 200

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[ \w\.,]+$

try pattern

Definitions group TokenInfo

Reference this group by using

{ "$ref": "https://yopen.org/tokenlist.schema.json#/definitions/TokenInfo" }

Property	Type	Required	Nullable	Defined by
chainId	integer	Required	cannot be null	SushiSwap Token List
address	string	Required	cannot be null	SushiSwap Token List
decimals	integer	Required	cannot be null	SushiSwap Token List
name	string	Required	cannot be null	SushiSwap Token List
symbol	string	Required	cannot be null	SushiSwap Token List
logoURI	string	Optional	cannot be null	SushiSwap Token List
tags	array	Optional	cannot be null	SushiSwap Token List
extensions	object	Optional	cannot be null	SushiSwap Token List

chainId

The chain ID of the Ethereum network where this token is deployed

chainId

• is required

• Type: integer

• cannot be null

• defined in: SushiSwap Token List

chainId Type

integer

chainId Constraints

minimum: the value of this number must greater than or equal to: 1

chainId Examples

1

42

address

The checksummed address of the token on the specified chain ID

address

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

address Type

string

address Constraints

pattern: the string must match the following regular expression:

^0x[a-fA-F0-9]{40}$

try pattern

address Examples

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

decimals

The number of decimals for the token balance

decimals

• is required

• Type: integer

• cannot be null

• defined in: SushiSwap Token List

decimals Type

integer

decimals Constraints

maximum: the value of this number must smaller than or equal to: 255

minimum: the value of this number must greater than or equal to: 0

decimals Examples

18

name

The name of the token

name

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

name Type

string

name Constraints

maximum length: the maximum number of characters for this string is: 40

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[ \w.'+\-%/À-ÖØ-öø-ÿ\:]+$

try pattern

name Examples

"USD Coin"

symbol

The symbol for the token; must be alphanumeric

symbol

• is required

• Type: string

• cannot be null

• defined in: SushiSwap Token List

symbol Type

string

symbol Constraints

maximum length: the maximum number of characters for this string is: 20

minimum length: the minimum number of characters for this string is: 1

pattern: the string must match the following regular expression:

^[a-zA-Z0-9+\-%/\$]+$

try pattern

symbol Examples

"USDC"

logoURI

A URI to the token logo asset; if not set, interface will attempt to find a logo based on the token address; suggest SVG or PNG of size 64x64

logoURI

• is optional

• Type: string

• cannot be null

• defined in: SushiSwap Token List

logoURI Type

string

logoURI Constraints

URI: the string must be a URI, according to RFC 3986

logoURI Examples

"ipfs://QmXfzKRvjZz3u5JRgC4v5mGVbm9ahrUiB4DgzHBsnWbTMM"

tags

An array of tag identifiers associated with the token; tags are defined at the list level

tags

• is optional

• Type: string[]

• cannot be null

• defined in: SushiSwap Token List

tags Type

string[]

tags Constraints

maximum length: the maximum number of characters for this string is: 10

tags Examples

"stablecoin"

"compound"

extensions

An object containing any arbitrary or vendor-specific token metadata

extensions

• is optional

• Type: object (Details)

• cannot be null

• defined in: SushiSwap Token List

extensions Type

object (Details)

extensions Constraints

maximum number of properties: the maximum number of properties for this object is: 10

extensions Examples

{
  "color": "#000000",
  "is_verified_by_me": true
}

License

Registry and Tokenlist Data is under Copyright 2021 The SushiSwap Contributors

Nodejs Components under Apache-2.0

https://yopen.org/tokenlist.schema.json