Marketjs NPM | npm.io

MARKET Protocol has been created to provide a secure, flexible, open source foundation for decentralized trading on the Ethereum blockchain. We provide the pieces necessary to create a decentralized exchange, including the requisite clearing and collateral pool infrastructure, enabling third parties to build applications for trading.

MARKET.js

Take a look at our docs for a little more explanation.

Join our Discord Community to interact with members of our dev staff and other contributors.

MARKET.js is a library for interacting with MARKET Protocol Smart Contracts.

Functionality

COMING SOON!

Orders
- generating and signing
- filling and cancelling
- verifying signature
- calculating remaining Qtys
Collateral
- checking a users unallocated collateral balances
- checking a users allocated collateral
- calculation of needed collateral
- wrapper for ERC20 token functionality.
Positions
- querying users open positions (qty and price)
- PnL calculations
Events
- Fills
- Collateral Deposit / Withdraw
- Contract Settlement
- Cancelled / Expired orders
Contract Registry
MKT Token Access to contracts
more coming soon!

Contributing

Want to hack on MARKET Protocol? Awesome!

MARKET Protocol is an Open Source project and we welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.

Ready to jump in? Check docs.marketprotocol.io/#contributing.

Questions?

Join our Discord Community to get in touch with our dev staff and other contributors.

Usage

$ git clone https://github.com/MARKETProtocol/MARKET.js
$ YOURFOLDERNAME
$ cd YOURFOLDERNAME
$ npm install

Features

RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
Tests, coverage and interactive watch mode using Jest
Prettier and TSLint for code formatting and consistency
Docs automatic generation and deployment to gh-pages, using TypeDoc
Automatic types (*.d.ts) file generation
Travis integration and Coveralls report
(Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)

Importing library

You can import the generated bundle to use the whole library generated by this starter:

import Market from 'marketjs'

Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:

import something from 'marketjs/dist/lib/something'

NPM scripts

npm run test: Run test suite
npm run start: Run npm run build in watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Excluding peerDependencies

On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.

Good news: the setup is here for you, you must only include the dependency name in external property within rollup.config.js. For example, if you want to exclude lodash, just write there external: ['lodash'].

Automatic releases

Prerequisites: you need to create/login accounts and add your project to:

Prerequisite for Windows: Semantic-release uses node-gyp so you will need to install Microsoft's windows-build-tools using this command:

npm install --global --production windows-build-tools

Setup steps

Follow the console instructions to install semantic release and run it (answer NO to "Do you want a .travis.yml file with semantic-release setup?").

Note: make sure you've setup repository.url in your package.json file

npm install -g semantic-release-cli
semantic-release-cli setup
# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P

From now on, you'll need to use npm run commit, which is a convenient way to create conventional commits.

Automatic releases are possible thanks to semantic release, which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by Kent C. Dodds course on egghead.io

Git Hooks

There is already set a precommit hook for formatting your code with Prettier :nail_care:

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

You follow a conventional commit message
Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push

This makes more sense in combination with automatic releases

FAQ

`Array.prototype.from`, `Promise`, `Map`... is undefined?

TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).

For a library, core-js plays very nicely, since you can import just the polyfills you need:

import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...

What if I don't want git-hooks, automatic releases or semantic-release?

Then you may want to:

Remove commitmsg, postinstall scripts from package.json. That will not use those git hooks to make sure you make a conventional commit
Remove npm run semantic-release from .travis.yml