@firefly-exchange/firefly-math

Tools

The Tools included are:

• ts-node
• typescript
• mocha
• chai
• sinon
• sinon-chai

Getting Started

1. git clone https://github.com/fireflyprotocol/firefly-math
2. git checkout main
3. yarn
4. yarn build / yarn clean-build

How to run tests

Simply type yarn test:unit and all tests will be run.

How to publish

1. remove .js from .gitignore
2. yarn build before publish
3. npm publish

How to add this library in other projects

yarn add @firefly-exchange/firefly-math

Configuration

All Mocha Configuration is handled via the mocha.opts File, this includes:

• Compiler-Options: Tests are ran with ts-node directly to skip a compilation phase
• Test-Filter-Patterns: All files ending with test.ts will be included in tests
• Globals and Plugin registration: plugins (e.g. sinon-chai) can be registered within the mocha-globals.js File