UNPKG

@firefly-exchange/firefly-client

Version:

The Firefly Client Library allows traders to sign, create, retrieve and listen to orders on Firefly Exchange.

github.com/fireflyprotocol/ffly-client

fireflyprotocol/firefly-client

23 lines (14 loc) • 1.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Firefly 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/firefly-client/build_check.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 Firefly 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 firefly's on-chain and off-chain part of the protocol. The documentation about the library could be found [here](https://docs.firefly.exchange) Examples on how to use the library are available [here](https://github.com/fireflyprotocol/FireflyClient/tree/main/examples) ## How To? - Build library using `yarn build` - To run tests, do `yarn test` - To run linter, use `yarn lint`