1.0.7 • Published 2 years ago

@indexcoop/index-exchange-issuance-sdk v1.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Index Exchange Issuance SDK

The SDK provides helper functions for using Index's exchange issuance contracts from your app.

The Contracts

To find out more about the exchange issuance contracts, go to Index's smart contracts repo.

This SDK currently supports:

  • ExchangeIssuanceLeveraged
  • ExchangeIssuanceZeroEx

The contract addresses can be found here. Check out the utility functions for easily obtaining the correct addresses and contracts.

Setup

$ npm i @indexcoop/index-exchange-issuance-sdk
or
$ yarn add @indexcoop/index-exchange-issuance-sdk

TBA

Limitations

TBA

Usage

Quotes

TBA

Trades

TBA

Contributing

$ npm run commit

REQUIRED: Due to the use of semantic-release for deploying to npm's registry, we require commits to be formatted in a specific way. This is made easy by the above npm script. If your commit doesn't use the above command for styling, it won't be picked up by semantic-release for publishing.

.env vars

When adding new .env vars do not forget to update the publish.yml

License

Copyright © 2022 Index Coop.

MIT License