Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.23 KB

README.md

File metadata and controls

19 lines (12 loc) · 1.23 KB

@gardenfi/orderbook

The @gardenfi/orderbook package is used to facilitate the creation of orders. It also provides functionality for listening to orders and retrieving orders created by a specific address.

Installation

npm install @gardenfi/orderbook

Usage

  1. Creating an order: (should create an order with the valid configuration)
  2. Getting all orders created by an address: (should return orders where the user is the maker)
  3. Listening to orders: (should update when order is created)

Setup

Both CommonJs and ES imports are supported so there is not extra setup needed to use the library. To use the orderbook simply import it (using import or require statements) and perform your logic. Make sure to use a signer if you're using the library in an environment where you do not have access to the private keys.