Awesome

Install

npm install @ethereum-alarm-clock/lib --save

lib

This package contains all of the key logic necessary for the interacting with the Ethereum Alarm Clock contracts.

Contribute

If you would like to hack on lib or notice a bug, please open an issue or come find us on the Ethereum Alarm Clock Gitter channel and tell us. If you're feeling more ambitious and would like to contribute directly via a pull request, that's cool too. We will review all pull requests and issues opened on this repository. Even if you think something isn't working right or that it should work another way, we would really appreciate if you helped us by opening an issue!

How to Build

If you decide to contribute then you will be working on the TypeScript files in the src/ directory. However, we don't export these files to the world, but we transpile them down to ES5 first. We do this by initiating the TypeScript compiler.

But, you can use the scripts provided in the package.json file to help you build the files.

npm run build

It will produce an index.js file which can be imported into any project and used.

Test

npm run ganache
./scripts/deployContracts.sh
npm run test

How to Lint

Initiate linting process by calling:

npm run lint

Want more?

This package is a part of EAC family ~