2.0.1 • Published 1 year ago

@irdsrl/orderbook-js v2.0.1

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
1 year ago

OrderBook-js

Library for creating orderbook objects. Uses binary order three for each side.

`npm install --save @irdsrl/orderbook-js

module.exports = {
  OrderBook,
  Order,
  Trade,
  OrderTree,
  enums,
};

enums

OrderbookSides

  • BUY
  • SELL

OrderbookEvents

events emitted by the orderbook

  • orderFilled
  • orderPartiallyFilled
  • orderPosted
  • orderCancel
  • tradeExecuted

example

import { OrderBook, Order, OrderbookSides, OrderbookEvents }  from '@irdsrl/orderbook-js';

const orderbook = OrderBook.create();

orderbook.on(OrderbookEvents.orderPosted, ({ order })=> console.log(`order posted ${order}`))

const order = Order.create({
      side: sides.BUY,
      price: 1.00,
      volume: 100,
});

orderbook.post(order).then(()=>{
        // do something after submission has been processed by orderbook.

        // log the best prices, with coresponding volumes on both BUY and SELL sides of the orderbook
        console.log(orderbook.peek());
        
        setTimeout(()=>{
        // cancel the order after 1 second
        orderbook.cancel(order.id);
}, 1000);
});

OrderBook

event emitter

.post(anOrder) , returns Promise

.cancel(anOrder.id) , returns Promise

.peek(side = undefined) , returns object

.peek() output

{ BUY: { price, volume, side }, SELL: { price, volume, side } }

.peek(sides.BUY)

{ price, volume, side }

changes

2.0.1

1 year ago

2.0.0

1 year ago