Skip to content

Latest commit

 

History

History
executable file
·
100 lines (64 loc) · 1.71 KB

README.md

File metadata and controls

executable file
·
100 lines (64 loc) · 1.71 KB
Raw

@ripio/diaspore-contract-wrappers

Smart TS wrappers for RCN diaspore smart contracts.

Installation

Install

npm install @ripio/diaspore-contract-wrappers --save

Import

import { DiasporeWeb3API } from '@ripio/rcn-diaspore-sdk';

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}

Sandbox

We provide a sandbox dev server to manually play with the package in the browser

To boot it up:

yarn start

This will generate a git-ignored sandbox.ts file you can edit locally to start playing around with the code

Contributing

We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

yarn build

or continuously rebuild on change:

yarn watch

Clean

yarn clean

Lint

yarn lint

Testing

This project uses Jest to do unit testing on the contract wrappers.

yarn jest

Deployment

** Pending, should run a prepublish script on CI or use Semantic Releases**

Examples

https://gist.github.com/jpgonzalezra/b3dc8405a7d2e804dcaf10d75c12856e