@muirglacier/jellyfish

https://jellyfish.defichain.com

DeFiChain Jellyfish SDK. A collection of TypeScript + JavaScript tools and libraries to build Native DeFi products.

We are consolidating all jellyfish ecosystem projects ocean, whale, playground, and salmon into this repository.

• For better synergy of DeFiChain open source development across all concerns.
• Consistent versioning for all ecosystem releases with a single source of truth.
• Documentation for the entirety of the jellyfish ecosystem via jellyfish.defichain.com. Incorporating sample and playground.
• Early regression detection upstream to downstream changes with monolithic repo structure.

Packages

DeFi Jellyfish follows a monorepo methodology, all maintained packages are in the same repo and published with the same version tag.

| Package | Description | |----------------------------------------------|------------------------------------------------------------------------------------------------------------------------| | @muirglacier/jellyfish-address | Provide address builder, parser, validator utility library for DeFi Blockchain. | | @muirglacier/jellyfish-api-core | A protocol agnostic DeFi Blockchain client interfaces, with a "foreign function interface" design. | | @muirglacier/jellyfish-api-jsonrpc | Implements the JSON-RPC 1.0 specification for api-core. | | @muirglacier/jellyfish-block | Stateless raw block composer for the DeFi Blockchain. | | @muirglacier/jellyfish-buffer | Buffer composer for jellyfish. | | @muirglacier/jellyfish-crypto | Cryptography operations for jellyfish, includes a simple 'secp256k1' EllipticPair. | | @muirglacier/jellyfish-json | Allows parsing of JSON with 'lossless', 'bignumber' and 'number' numeric precision. | | @muirglacier/jellyfish-network | Contains DeFi Blockchain various network configuration for mainnet, testnet and regtest. | | @muirglacier/jellyfish-testing | Provides many abstractions for various commonly used setup pattern for DeFi Blockchain. | | @muirglacier/jellyfish-transaction | Dead simple modern stateless raw transaction composer for the DeFi Blockchain. | | @muirglacier/jellyfish-transaction-builder | Provides a high-high level abstraction for constructing transaction ready to be broadcast for DeFi Blockchain. | | @muirglacier/jellyfish-transaction-signature | Stateless utility library to perform transaction signing. | | @muirglacier/jellyfish-wallet | Jellyfish wallet is a managed wallet, where account can get discovered from an HD seed. | | @muirglacier/jellyfish-wallet-classic | WalletClassic implements a simple, single elliptic pair wallet. | | @muirglacier/jellyfish-wallet-encrypted | Library to encrypt MnemonicHdNode as EncryptedMnemonicHdNode. Able to perform as MnemonicHdNode with passphrase known. | | @muirglacier/jellyfish-wallet-mnemonic | MnemonicHdNode implements the WalletHdNode from jellyfish-wallet; a CoinType-agnostic HD Wallet for noncustodial DeFi. | | @muirglacier/testcontainers | Provides a lightweight, throw away instances for DeFiD node provisioned automatically in a Docker container. | | ~~@muirglacier/testing~~ | (deprecated) ~~Provides rich test fixture setup functions for effective and effortless testing.~~ |

Developing & Contributing

Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along the way to make it merge-able. Here are some of our documented contributing guidelines.

Security issues

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

License & Disclaimer

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