setprotocol.js

setprotocol.js is a library for interacting with Set Protocol smart contracts. This library enables you to create, issue, redeem, and create and fill issuance orders for Sets.

Take a look at our developer portal for the fastest way to get up and running.

Note: This is Alpha software, and is subject to non-backwards compatible changes.

:computer: Installation

setprotocol.js

Using yarn:

$ yarn add setprotocol.js@^1.2.8

Using npm:

$ npm i --save setprotocol.js@^1.2.8

Setup

For the most up to date steps on how to initialize and use setProtocol.js, please refer to our installation guide.

:raising_hand: Contributing

Testing

Compile & Migrate Contracts

Start testrpc and setup dependencies:

yarn chain

Wait until the dependency migration complete message appears before interacting with the contracts. In a new terminal window, run:

yarn test:watch

Troubleshooting

Do not use Node version 10+ as it may have issues during npm install or yarn install with the sha3 package. Use nvm install 9.11.1 && nvm use 9.11.1 for now.

Occasionally, you may need to run yarn run chain --reset or just re-run yarn chain to make sure that you have up to date contracts after running yarn install with an update to the set-protocol-contracts package.