https://github.com/sambacha/tokenlist-types

uniswap token-list types and schemas
https://github.com/sambacha/tokenlist-types

ethereum ethers sushiswap token-list tokenlist types uniswap

Last synced: 2 months ago
JSON representation

uniswap token-list types and schemas

• Host: GitHub
• URL: https://github.com/sambacha/tokenlist-types
• Owner: sambacha
• Created: 2021-04-14T20:40:33.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-14T20:56:45.000Z (about 4 years ago)
• Last Synced: 2025-03-26T23:44:47.843Z (2 months ago)
• Topics: ethereum, ethers, sushiswap, token-list, tokenlist, types, uniswap
• Language: TypeScript
• Homepage:
• Size: 79.1 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# [@types/tokenlist](#)

> @uniswap/token-lists

## @types/tokenlist

## Index

### Interfaces

* [Tags](interfaces/tags.md)

* [TokenInfo](interfaces/tokeninfo.md)

* [TokenList](interfaces/tokenlist.md)

* [Version](interfaces/version.md)

### Variables

* [VersionUpgrade](globals.md#const-versionupgrade)

* [schema](globals.md#const-schema)

### Functions

* [diffTokenLists](globals.md#difftokenlists)

* [getVersionUpgrade](globals.md#getversionupgrade)

* [isVersionUpdate](globals.md#isversionupdate)

* [minVersionBump](globals.md#minversionbump)

* [nextVersion](globals.md#nextversion)

* [versionComparator](globals.md#versioncomparator)

## Variables

### `Const` VersionUpgrade

• **VersionUpgrade**: *object*

*Defined in [token.d.ts:3](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L3)*

Declaration file generated by dts-gen

#### Type declaration:

* **0**: *string*

* **1**: *string*

* **2**: *string*

* **3**: *string*

* **MAJOR**: *number*

* **MINOR**: *number*

* **NONE**: *number*

* **PATCH**: *number*

___

### `Const` schema

• **schema**: *object*

*Defined in [token.d.ts:14](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L14)*

#### Type declaration:

* **$id**: *string*

* **$schema**: *string*

* **additionalProperties**: *boolean*

* **definitions**(): *object*

  * **ExtensionIdentifier**(): *object*

    * **description**: *string*

    * **examples**: *string[]*

    * **maxLength**: *number*

    * **minLength**: *number*

    * **pattern**: *string*

    * **type**: *string*

  * **ExtensionValue**(): *object*

    * **anyOf**: *object[]*

  * **TagDefinition**(): *object*

    * **additionalProperties**: *boolean*

    * **description**: *string*

    * **examples**: *object[]*

    * **properties**(): *object*

      * **description**(): *object*

        * **description**: *string*

        * **maxLength**: *number*

        * **minLength**: *number*

        * **pattern**: *string*

        * **type**: *string*

      * **name**(): *object*

        * **description**: *string*

        * **maxLength**: *number*

        * **minLength**: *number*

        * **pattern**: *string*

        * **type**: *string*

    * **required**: *string[]*

    * **type**: *string*

  * **TagIdentifier**(): *object*

    * **description**: *string*

    * **examples**: *string[]*

    * **maxLength**: *number*

    * **minLength**: *number*

    * **pattern**: *string*

    * **type**: *string*

  * **TokenInfo**(): *object*

    * **additionalProperties**: *boolean*

    * **description**: *string*

    * **properties**(): *object*

      * **address**(): *object*

        * **description**: *string*

        * **examples**: *string[]*

        * **pattern**: *string*

        * **type**: *string*

      * **chainId**(): *object*

        * **description**: *string*

        * **examples**: *number[]*

        * **minimum**: *number*

        * **type**: *string*

      * **decimals**(): *object*

        * **description**: *string*

        * **examples**: *number[]*

        * **maximum**: *number*

        * **minimum**: *number*

        * **type**: *string*

      * **extensions**(): *object*

        * **additionalProperties**(): *object*

          * **$ref**: *string*

        * **description**: *string*

        * **examples**: *object[]*

        * **maxProperties**: *number*

        * **propertyNames**(): *object*

          * **$ref**: *string*

        * **type**: *string*

      * **logoURI**(): *object*

        * **description**: *string*

        * **examples**: *string[]*

        * **format**: *string*

        * **type**: *string*

      * **name**(): *object*

        * **description**: *string*

        * **examples**: *string[]*

        * **maxLength**: *number*

        * **minLength**: *number*

        * **pattern**: *string*

        * **type**: *string*

      * **symbol**(): *object*

        * **description**: *string*

        * **examples**: *string[]*

        * **maxLength**: *number*

        * **minLength**: *number*

        * **pattern**: *string*

        * **type**: *string*

      * **tags**(): *object*

        * **description**: *string*

        * **examples**: *string[]*

        * **items**(): *object*

          * **$ref**: *string*

        * **maxLength**: *number*

        * **type**: *string*

    * **required**: *string[]*

    * **type**: *string*

  * **Version**(): *object*

    * **additionalProperties**: *boolean*

    * **description**: *string*

    * **examples**: *object[]*

    * **properties**(): *object*

      * **major**(): *object*

        * **description**: *string*

        * **examples**: *number[]*

        * **minimum**: *number*

        * **type**: *string*

      * **minor**(): *object*

        * **description**: *string*

        * **examples**: *number[]*

        * **minimum**: *number*

        * **type**: *string*

      * **patch**(): *object*

        * **description**: *string*

        * **examples**: *number[]*

        * **minimum**: *number*

        * **type**: *string*

    * **required**: *string[]*

    * **type**: *string*

* **description**: *string*

* **properties**(): *object*

  * **keywords**(): *object*

    * **description**: *string*

    * **items**(): *object*

      * **description**: *string*

      * **examples**: *string[]*

      * **maxLength**: *number*

      * **minLength**: *number*

      * **pattern**: *string*

      * **type**: *string*

    * **maxItems**: *number*

    * **type**: *string*

    * **uniqueItems**: *boolean*

  * **logoURI**(): *object*

    * **description**: *string*

    * **examples**: *string[]*

    * **format**: *string*

    * **type**: *string*

  * **name**(): *object*

    * **description**: *string*

    * **examples**: *string[]*

    * **maxLength**: *number*

    * **minLength**: *number*

    * **pattern**: *string*

    * **type**: *string*

  * **tags**(): *object*

    * **additionalProperties**(): *object*

      * **$ref**: *string*

    * **description**: *string*

    * **examples**: *object[]*

    * **maxProperties**: *number*

    * **propertyNames**(): *object*

      * **$ref**: *string*

    * **type**: *string*

  * **timestamp**(): *object*

    * **description**: *string*

    * **format**: *string*

    * **type**: *string*

  * **tokens**(): *object*

    * **description**: *string*

    * **items**(): *object*

      * **$ref**: *string*

    * **maxItems**: *number*

    * **minItems**: *number*

    * **type**: *string*

  * **version**(): *object*

    * **$ref**: *string*

* **required**: *string[]*

* **title**: *string*

* **type**: *string*

## Functions

###  diffTokenLists

▸ **diffTokenLists**(`base`: any, `update`: any): *any*

*Defined in [token.d.ts:244](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L244)*

**Parameters:**

Name | Type |

------ | ------ |

`base` | any |

`update` | any |

**Returns:** *any*

___

###  getVersionUpgrade

▸ **getVersionUpgrade**(`base`: any, `update`: any): *any*

*Defined in [token.d.ts:246](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L246)*

**Parameters:**

Name | Type |

------ | ------ |

`base` | any |

`update` | any |

**Returns:** *any*

___

###  isVersionUpdate

▸ **isVersionUpdate**(`base`: any, `update`: any): *any*

*Defined in [token.d.ts:248](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L248)*

**Parameters:**

Name | Type |

------ | ------ |

`base` | any |

`update` | any |

**Returns:** *any*

___

###  minVersionBump

▸ **minVersionBump**(`baseList`: any, `updatedList`: any): *any*

*Defined in [token.d.ts:250](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L250)*

**Parameters:**

Name | Type |

------ | ------ |

`baseList` | any |

`updatedList` | any |

**Returns:** *any*

___

###  nextVersion

▸ **nextVersion**(`base`: any, `bump`: any): *any*

*Defined in [token.d.ts:252](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L252)*

**Parameters:**

Name | Type |

------ | ------ |

`base` | any |

`bump` | any |

**Returns:** *any*

___

###  versionComparator

▸ **versionComparator**(`versionA`: any, `versionB`: any): *any*

*Defined in [token.d.ts:254](https://github.com/sambacha/tokenlist-types/blob/f2879ad/token.d.ts#L254)*

**Parameters:**

Name | Type |

------ | ------ |

`versionA` | any |

`versionB` | any |

**Returns:** *any*

[@types/tokenlist](../globals.md) › [Tags](tags.md)

# Interface: Tags

## Hierarchy

* **Tags**

## Indexable

* \[ **tagId**: *string*\]: object

* **description**: *string*

* **name**: *string*