@alcorexchange/alcor-swap-sdk/src/entities/token.ts

## Installation ​​ **npm** ``` npm i @alcorexchange/alcor-swap-sdk ``` **yarn** ``` yarn add @alcorexchange/alcor-swap-sdk ``` ## Usage ### Import:

import invariant from "tiny-invariant";
import { BaseCurrency } from "./baseCurrency";
import { symbol, name } from "eos-common"

/**
 * Represents an ERC20 token with a unique address and some metadata.
 */
export class Token extends BaseCurrency {
  /**
   * @param contract {@link BaseCurrency#contract}
   * @param decimals {@link BaseCurrency#decimals}
   * @param symbol {@link BaseCurrency#symbol}
   */
  public constructor(
    contract: string,
    decimals: number,
    symbol: string,
  ) {
    super(contract, decimals, symbol);
  }

  public get name(): string {
    console.warn('Token.name is deprecated, use token.id')
    return this.symbol.toLowerCase() + '-' + this.contract
  }

  /**
   * Returns true if the two tokens are equivalent, i.e. have the same contract and symbol.
   * @param other other token to compare
   */
  public equals(other: Token): boolean {
    return (
      this.contract === other.contract &&
      this.symbol === other.symbol &&
      this.decimals === other.decimals
    );
  }

  /**
   * Returns true if the address of this token sorts before the address of the other token
   * @param other other token to compare
   * @throws if the tokens have the same contract and symbol
   */
  public sortsBefore(other: Token): boolean {
    if (this.contract === other.contract) {
      invariant(this.symbol !== other.symbol, "SYMBOLS");
      const token0Symbol = symbol(this.symbol, this.decimals);
      const token1Symbol = symbol(other.symbol, other.decimals);
      return token0Symbol.raw().lt(token1Symbol.raw());
    } else {
        return name(this.contract).raw().lt(name(other.contract).raw());
    }
  }

  static toJSON(token: Token) {
    return {
      contract: token.contract,
      decimals: token.decimals,
      symbol: token.symbol,
    }
  }

  static fromJSON(json: any) {
    return new Token(json.contract, json.decimals, json.symbol);
  }
}