Code Monkey home page Code Monkey logo

coin_payments's Introduction

coin-payments monorepo

A nodejs library providing a unified API for sending and receiving crypto payments for multiple coin networks.

Setting Up

  1. Install root dependencies:
npm install
  1. Install dependencies for packages and link them together (done by lerna)
npm run bs
  1. Execute tests (done by Jest)
npm run test

Contribution guide

Pull Request process

  1. Ensure following branch naming conventions <tag>/<subject_message>;
  2. Ensure following commit message conventions (templated);
  3. Ensure test and linting are executed successfully;
  4. 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;

Commit message template

Run

git config commit.template  ./.gitmessage

Adding new assets

Importing packages

Use lerna to import packages (More info in lerna docs)

Configuring assets

Add payment factory to packages/coin-payments/src/constants.ts

Registering assets

Add payment config to packages/coin-payments/src/types.ts

Abstractions to implement

Find types and interfaces at packages/payments-common/src/

Usage

npm i @faast/coin-payments

See @faast/coin-payments README for usage.

Packages

Publishing new version

Note: Never use npm version, it doesn't work with monorepo

Version types

  • patch - fixes only, no feature or breaking changes
  • minor - feature changes
  • major - breaking changes

Steps to publish

  1. Run tests npm run test
  2. Boostrap packages npm run bs
  3. Create version commit and publish to npm lerna publish (patch|minor|major)

or

  1. Create a new version commit lerna version (patch|minor|major)
  2. Publish to npm lerna publish from-git

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.