Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Market

Index

Constructors

  • new Market(tonic: Tonic, id: string, _inner: MarketViewV1): Market

Properties

baseDecimals: number
baseLotSize: number
id: string
quoteDecimals: number
quoteLotSize: number

Accessors

  • get baseTokenId(): string
  • get baseTokenType(): TokenType
  • get feesAccrued(): BN
  • get makerRebateBaseRate(): number
  • get maxOrdersPerAccount(): number
  • get priceTick(): number
  • get quantityTick(): number
  • get quoteTokenId(): string
  • get quoteTokenType(): TokenType
  • get takerFeeBaseRate(): number
  • get totalOpenOrders(): number

Methods

  • Return the orderbook with prices and quantities converted to human-readable numbers, eg, an order for 0.1 BTC @ 54321.00 USDC will be returned as [54321, 01].

    Parameters

    • Optional depth: number

    Returns Promise<NumberOrderbook>

  • getOrderbookRaw(depth?: number): Promise<Orderbook>
  • placeOrder(params: NewOrderParams): Promise<{ executionOutcome: FinalExecutionOutcome; response: OrderResultV1 }>
  • priceBnToNumber(price: BN, precision?: number): number
  • priceNumberToBn(price: number, floor?: boolean, round_trailing_decimals_up?: boolean): BN
  • Given price as a number, return a decimal-padded BN optionally floored to the nearest quote lot size.

    If round_trailing_decimals_up===true, the least significant digit + trailing digits are rounded up their ceiling.

    Parameters

    • price: number
    • floor: boolean = true
    • round_trailing_decimals_up: boolean = false

    Returns BN

  • priceNumberToBnLots(price: number, floor?: boolean): BN
  • quantityBnToNumber(quantity: BN, precision?: number): number
  • Given quantity as a decimal-padded BN, return a decimal.

    Parameters

    • quantity: BN
    • Optional precision: number

    Returns number

  • quantityNumberToBn(quantity: number, floor?: boolean): BN
  • Given order size as a number, return a decimal-padded BN optionally floored to the nearest base lot size.

    Parameters

    • quantity: number
    • floor: boolean = true

    Returns BN

  • quantityNumberToBnLots(quantity: number, floor?: boolean): BN
  • Given order size as a number, return an equivalent BN of lots.

    Parameters

    • quantity: number
    • floor: boolean = true

    Returns BN

  • load(tonic: Tonic, id: string, contractId: string): Promise<Market>

Generated using TypeDoc