Skip to content

Latest commit

 

History

History
160 lines (93 loc) · 7.41 KB

README.md

File metadata and controls

160 lines (93 loc) · 7.41 KB
Raw

Codex Protocol | Ethereum Event Listener (aka "EEL") (service.eel)

standard-readme compliant

A simple service that listens for events emitted by Codex Protocol smart contracts on the Ethereum blockchain.

This service sequentially processes blocks on the Ethereum blockchain, listening for events emitted by Codex Protocol smart contracts. It then logs those events to a MongoDB server for arbitrary consumption by other Codex Protocol applications (e.g. the Codex Registry API.)

Table of Contents

Security

This project requires the use of some "secret" variables that should be tailored to your development environment and never committed to the repository. These variables are read by dotenv and should be defined in a file called .env in the project root.

After cloning the repository, duplicate and rename .env.example to .env, then tailor the variables to your local environment accordingly:

$ cp .env.example .env
$ vi .env

.env.example has suitable local development defaults for most variables. Descriptions for each variable are listed in .env.example.

Install

For EEL to be able to index for events, it first needs to know which contract addresses to look up events for. All Codex Protocol smart contracts are centralized in the ethereum-service repository. To populate the ethereum-service repository with your locally-deployed contracts and get EEL up and running, follow these steps:

Clone & Set Up Required Repositories

  1. First, clone this repository and all dependency repositories (see Dependencies below for more details):

    $ git clone https://github.com/codex-protocol/contract.codex-registry
$ git clone https://github.com/codex-protocol/npm.ethereum-service
$ git clone https://github.com/codex-protocol/service.eel

    IMPORTANT NOTE: It's necessary to have all of these repositories in the same directory, since our npm scripts assume this is the case.

  2. Then install all npm packages in each repository:

    $ cd ../contract.codex-registry
$ npm install

$ cd ../npm.ethereum-service
$ npm install

$ cd ../service.eel
$ npm install

  3. After you've installed all npm packages, you will also need to npm link the ethereum-service repository so that EEL can use your locally-deployed smart contracts:

    $ cd npm.ethereum-service
$ npm link

$ cd ../service.eel
$ npm link @codex-protocol/ethereum-service

    Now when you deploy the smart contracts locally, EEL will be able to pull the ABIs from the linked ethereum-service repository.

    IMPORTANT NOTE: every time you run npm install in the EEL repository, you will need to re-link the ethereum-service repository. For convenience, you can simply run the npm script npm run link-all to link, or npm run install-and-link to install and link in one step. (You re-link in the EEL repository, not the ethereum-service repository.)

Dependencies

Now you will need to install & set up some dependencies.

  1. MongoDB

    MongoDB is where EEL stores indexed events for consumption by other Codex Protocol applications. It's also used by Agenda to track jobs.

    On MacOS, MongoDB can be installed via Homebrew:

    $ brew install mongodb

    For other platforms, MongoDb can be downloaded directly from the MongoDB website.

  2. Ganache

    Ganache is a blockchain development application that allows you to deploy & test contracts locally.

    You can download Ganache directly from the Truffle Framework website.

  3. Link the ethereum-service Repository

    Make sure you've cloned the ethereum-service repository and have npm linked it so that EEL will be able to use your locally-deployed smart contracts (see Clone & Set Up Required Repositories above).

    For more information on this repository, see the README.

  4. Deploy Codex Registry Smart Contracts

    After you've set up Ganache and linked the ethereum-service repository, you will need to deploy the Codex Registry smart contracts. Make sure Ganache is running, and then run:

    $ cd contract.codex-registry
$ npm run migrate:reset

    This will make Truffle deploy the contracts to Ganache and copy over the built contract JSON files to the ethereum-service repository, where EEL will be able to read them.

Configure

After you've installed & set up all dependencies, you should now update your .env file to match your local environment (for example, change the MongoDB port if you're not using the default.) See the Security section for more details on the .env file.

Usage

After you've deployed your contracts locally to Ganache, you can now start up EEL:

$ cd service.eel
$ npm start

Now any events emitted by the contracts you've deployed will be index in the MongoDB table blockchainevents. The Codex Registry API has it's own Agenda job that will periodically process these records and do what it will with them.

Maintainers

Contribute

If you have any questions, feel free to reach out to one of the repository maintainers or simply open an issue here on GitHub. If you have questions about Codex Protocol in general, feel free to reach out to us Telegram!

Pull Requests are not only allowed, but highly encouraged! All Pull Requests must pass CI checks (if applicable) and be approved by at least one repository maintainer before being considered for merge.

Codex Labs, Inc follows the Contributor Covenant Code of Conduct.

License

GNU Affero General Public License v3.0 or later © Codex Labs, Inc