stanly1102e / firefly-client

TypeScript Client for Firefly Exchange API and Smart Contracts

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Firefly Client Library

Firefly logo

GitHub Workflow Status GitHub package.json version GitHub

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

Examples on how to use the library are available here

How To?

  • Build library using yarn build
  • To run tests, do yarn test
  • To run linter, use yarn lint

About

TypeScript Client for Firefly Exchange API and Smart Contracts

License:GNU General Public License v3.0


Languages

Language:TypeScript 99.2%Language:JavaScript 0.7%Language:Shell 0.1%