@defichain/jellyfish-core v0.0.4

@defichain/jellyfish

A collection of TypeScript + JavaScript tools and libraries for DeFiChain to build decentralized finance on Bitcoin.

🚧 Work in progress.

Usage

For the majority of the time, you just need @defichain/jellyfish.

Installation

npm i @defichain/jellyfish

Setting a client

// TODO(fuxingloh): 

npm i @defichain/jellyfish
npm i @defichain/jellyfish-core
npm i @defichain/jellyfish-jsonrpc
npm i -D @defichain/testcontainers

Features

// TODO(fuxingloh): 

Documentation & Community

// TODO(fuxingloh): 

Motivation & Philosophy

// TODO(fuxingloh): 

Developing & Contributing

Thanks for contributing, here is our contributing guidelines.

We use npm 7 for this project, it's required to set up npm workspaces.

npm install

Testing

jest.config.js is set up at the root project level as well as at each sub module. You can run jest at root to test all modules or individually at each sub module. If you use IntelliJ IDEA, you can right click any file to test it individually and have it reported to the IDE.

Docker is required to run the tests as @defichain/testcontainers will automatically spin up regtest instances for testing.

Coverage is collected at merge with codecov; more testing 🚀 less 🐛 = 😎

jest

IntelliJ IDEA

IntelliJ IDEA is the IDE of choice for writing and maintaining this library. IntelliJ's files are included for convenience with basic toolchain setup but use of IntelliJ is totally optional.

Security issues

If you discover a security vulnerability in @defichain/jellyfish, please see submit it privately.

License & Disclaimer

By using @defichain/jellyfish (this repo), you (the user) agree to be bound by the terms of this license.