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.
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.
COMING SOON!
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.
Join our Discord Community to get in touch with our dev staff and other contributors.
$ git clone https://github.com/MARKETProtocol/MARKET.js
$ YOURFOLDERNAME
$ cd YOURFOLDERNAME
$ npm install
gh-pages, using TypeDoc(*.d.ts) file generationYou 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 run test: Run test suitenpm run start: Run npm run build in watch modenpm run test:watch: Run test suite in interactive watch modenpm run test:prod: Run linting and generate coveragenpm run build: Generate bundles and typings, create docsnpm run lint: Lints codenpm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)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'].
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
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
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:
git pushThis makes more sense in combination with automatic releases
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"
...
Then you may want to:
commitmsg, postinstall scripts from package.json. That will not use those git hooks to make sure you make a conventional commitnpm run semantic-release from .travis.ymlRemove npm run report-coverage from .travis.yml
Thanks to @alexjoverm for a great TypeScript library starter!
FAQs
library for interacting with MARKET Protocol
We found that marketjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.