@hydro-protocol/hydro-client-js
Version:
Javascript SDK for the Hydro API
70 lines (69 loc) • 1.96 kB
TypeScript
import { BigNumber } from "bignumber.js";
import { OrderType } from "./Order";
/**
* A representation of a market on the exchange, including the various
* limitations of the market.
*/
export declare class Market {
/**
* A token pair representing this market, e.g. "HOT-WETH"
*/
readonly id: string;
/**
* The symbol of the quote token
*/
readonly quoteToken: string;
/**
* The number of decimals used by the quote token
*/
readonly quoteTokenDecimals: number;
/**
* The contract address of the quote token
*/
readonly quoteTokenAddress: string;
/**
* The symbol of the base token
*/
readonly baseToken: string;
/**
* The number of decimals used by the base token
*/
readonly baseTokenDecimals: number;
/**
* The contract address of the base token
*/
readonly baseTokenAddress: string;
/**
* The minimum amount of the quote token you can specify in an order
*/
readonly minOrderSize: BigNumber;
/**
* The number of significant digits allowed for the price of an order
*/
readonly pricePrecision: number;
/**
* The maximum number of decimal places that can be used to specify the price of an order
*/
readonly priceDecimals: number;
/**
* The maximum number of decimal places that can be used to specify the amount of an order
*/
readonly amountDecimals: number;
/**
* The base fee rate that will be used for the order maker
*/
readonly asMakerFeeRate: BigNumber;
/**
* The base fee rate that will be used for the order taker
*/
readonly asTakerFeeRate: BigNumber;
/**
* The amount that will be charged for gas on orders
*/
readonly gasFeeAmount: BigNumber;
/**
* List of order types supported by this market
*/
readonly supportedOrderTypes: OrderType[];
constructor(json: any);
}