@plasma-fi/token-lists/dist/types.d.ts

📚 The Token Lists specification

import { TokenInfoChanges } from 'diff-token-lists';
export interface TokenInfo {
    readonly chainId: number;
    readonly address: string;
    readonly name: string;
    readonly decimals: number;
    readonly symbol: string;
    readonly logoURI?: string;
    readonly tags?: string[];
    readonly extensions?: {
        readonly [key: string]: string | number | boolean | null;
    };
}
export interface Version {
    readonly major: number;
    readonly minor: number;
    readonly patch: number;
}
export interface Tags {
    readonly [tagId: string]: {
        readonly name: string;
        readonly description: string;
    };
}
export interface TokenList {
    readonly name: string;
    readonly timestamp: string;
    readonly version: Version;
    readonly tokens: TokenInfo[];
    readonly keywords?: string[];
    readonly tags?: Tags;
    readonly logoURI?: string;
}
/**
 * Differences between a base list and an updated list.
 */
export interface TokenListDiff {
    /**
     * Tokens from updated with chainId/address not present in base list
     */
    readonly added: TokenInfo[];
    /**
     * Tokens from base with chainId/address not present in the updated list
     */
    readonly removed: TokenInfo[];
    /**
     * The token info that changed
     */
    readonly changed: {
        [chainId: number]: {
            [address: string]: TokenInfoChanges;
        };
    };
}