polymathjs

Polymath.js

Bridge between the Polymath Smart Contracts and dApps.

Install

> yarn add polymathjs

import Contract, { TickerRegistry } from 'polymathjs'
import type { NetworkParams } from 'polymathjs/types'

const params: NetworkParams = {
  id: 1, // network id
  web3, // Web3 1.0 instance
  web3WS, // Web3 1.0 instance supplied with WebsocketProvider, it can be the same instance as the one above
  account: '0xaea186fa5402f0a8049786099c3f2881c1e21767', // transactions sender
  txHashCallback: (hash) => console.log(hash), // receives a transaction hash every time one was generated
  txEndCallback: (receipt) => console.log(receipt), // receives a transaction receipt every time one was mined
}

Contract.setParams(params)

Consider using the polymath-auth library, which takes care of the first 4 params.

Development

After cloning, to install all dependencies run:

> yarn

We only use Yarn as our official Node package manager, and so we will only commit yarn.lock files, and ignore package-lock.json files.

To build module run:

npm run build