Skip to content

JavaScript library to interact with the Ethereum Alarm Clock.

License

Notifications You must be signed in to change notification settings

ethereum-alarm-clock/eac.js-lib

Repository files navigation

Note: eac.js is operational but we're still working out the bugs. If you use it on the mainnet please first educate yourself about the possible risks.

npm version Greenkeeper badge Build Status

eac.js-lib

This is a part of eac.js family that includes

Eac.js-lib is the collection of lightweight helpers and wrappers for the Ethereum Alarm Clock protocol.

Documentation

Documentation is available!

Testing

Install mocha npm i -g mocha and mocha at the root of the directory to run the test script on an isolated virtual blockchain using mocha.

Dev version deployment

  • git submodule init ethereum-alarm-clock
  • git submodule update
  • cd ethereum-alarm-clock && git checkout {branch} && cd ..
  • ganache-cli -b 4 -i 1002
  • ./deploy.sh

Contributing

Pull requests are always welcome. Not all functionalities of the Ethereum Alarm Clock smart contracts are translated to this library, it was mostly just utilities needed to write the client and grew from there. If you need some functionality and are not finding it in the API docs, please open a issue or contribute a pull request.

Questions or Concerns?

Since this is alpha software, we highly encourage you to test it, use it and try to break it. We would love your feedback if you get stuck somewhere or you think something is not working the way it should be. Please open an issue if you need to report a bug or would like to leave a suggestion. Pull requests are welcome.