@bluefin-exchange/bluefin-v2-client/README.md

The Bluefin client Library allows traders to sign, create, retrieve and listen to orders on Bluefin Exchange.

# Bluefin Client Library

[<img alt="Firefly logo" src="https://raw.githubusercontent.com/fireflyprotocol/firefly_exchange_client/main/res/banner.png" />](#)

<div align="center">

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fireflyprotocol/bluefin-v2-client-ts/publish_to_npm.yml)
![GitHub package.json version](https://img.shields.io/github/package-json/v/fireflyprotocol/firefly-client)
![GitHub](https://img.shields.io/github/license/fireflyprotocol/firefly-client)

</div>

A typescript Bluefin client library for creating signed orders and placing them on exchange.The library provides an interface to connect with on-chain contracts and off-chain orderbook and listen to socket events emitted from both Bluefin's on-chain and off-chain part of the protocol.

The documentation about the library could be found [here](https://bluefin-exchange.readme.io/v2.0/reference/introduction)

Examples on how to use the library are available [here](https://github.com/fireflyprotocol/bluefin-v2-client-ts/tree/main/examples)

## How To?

- Typescript version should be >= 5.
- Build library using `yarn build`
- To run tests, do `yarn test`
- To run linter, use `yarn lint`