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

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

import invariant from "tiny-invariant";
import { Currency } from "./currency";

/**
 * A currency is any fungible financial instrument, including Ether, all ERC20 tokens, and other chain-native currencies
 */
export abstract class BaseCurrency {
  /**
   * The contract address of the currency
   */
  public readonly contract: string;
  /**
   * The decimals used in representing currency amounts
   */
  public readonly decimals: number;
  /**
   * The symbol of the currency, i.e. a short textual non-unique identifier
   */
  public readonly symbol: string;

  public readonly id: string;

  /**
   * Constructs an instance of the base class `BaseCurrency`.
   * @param chainId the chain ID on which this currency resides
   * @param decimals decimals of the currency
   * @param symbol symbol of the currency
   * @param name of the currency
   */
  protected constructor(
    contract: string,
    decimals: number,
    symbol: string,
  ) {
    invariant(
      decimals >= 0 && decimals < 19 && Number.isInteger(decimals),
      "DECIMALS"
    );
    this.contract = contract;
    this.decimals = decimals;
    this.symbol = symbol;
    this.id = symbol.toLowerCase() + '-' + contract
  }

  /**
   * Returns whether this currency is functionally equivalent to the other currency
   * @param other the other currency
   */
  public abstract equals(other: Currency): boolean;
}