A nodejs library providing a unified API for sending and receiving crypto payments for multiple coin networks.
- Install root dependencies:
npm install- Install dependencies for packages and link them together (done by lerna)
npm run bs- Execute tests (done by Jest)
npm run test- Ensure following branch naming conventions
<tag>/<subject_message>; - Ensure following commit message conventions (templated);
- Ensure test and linting are executed successfully;
- You may merge the Pull Request in once you have the sign-off of other developers, or if you do not have permission to do that, you may request the reviewer to merge it for you;
Run
git config commit.template ./.gitmessageUse lerna to import packages (More info in lerna docs)
Add payment factory to packages/coin-payments/src/constants.ts
Add payment config to packages/coin-payments/src/types.ts
Find types and interfaces at packages/payments-common/src/
npm i @faast/coin-paymentsSee @faast/coin-payments README for usage.
- @faast/coin-payments - Wrapper for all coins
- @faast/payments-common - Common interfaces
- @faast/bitcoin-payments - BTC
- @faast/ethereum-payments - ETH & ERC20
- @faast/litecoin-payments - LTC
- @faast/doge-payments - DOGE
- @faast/bitcoin-cash-payments - BCH
- @faast/tron-payments - TRX
- @faast/stellar-payments - XLM
- @faast/ripple-payments - XRP
Note: Never use npm version, it doesn't work with monorepo
patch- fixes only, no feature or breaking changesminor- feature changesmajor- breaking changes
- Run tests
npm run test - Boostrap packages
npm run bs - Create version commit and publish to npm
lerna publish (patch|minor|major)
or
- Create a new version commit
lerna version (patch|minor|major) - Publish to npm
lerna publish from-git