Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.53 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.53 KB
Raw

Gnarly Demo

This is a super simple demo of how gnarly and paperboy work together to produce an event feed.

It uses the :demo tags of shrugs/gnarly-test and shrugs/paperboy, which may eventually be out of date.

Run the Demo

This demo relies on docker-compose. If you don't have it already, install docker and then install docker-compose. Install instructions vary between machines, so check the website for up-to-date docs.

Note: unfortunately, gnarly and paperboy don't attempt reconnects on failure just yet, so the services need to be started in the correct order. (for example, gnarly depends on postgres accepting connections, paperboy depends on gnarly having put at least one block already in the postgres table, etc—this will eventually be perfectly 12-factor).

  1. docker-compose up -d postgres and wait for it to be happy (~5 seconds), then
  2. docker-compose up -d gnarly
  3. in a separate window docker-compose logs -f gnarly
  4. docker-compose up -d paperboy
  5. docker-compose up wsecho (named because that's what comes to mind when I think of people reading the newspaper)
  6. Wait a few blocks to see some CryptoKitty Transfer events come in.

If you want it as a terrible one-liner:

docker-compose up -d postgres && \
    sleep 10 && \
    docker-compose up -d gnarly && \
    sleep 45 && \
    docker-compose up -d paperboy && \
    sleep 2 && \
    docker-compose up wsecho

You can watch the logs of gnarly with docker-compose logs -f gnarly

And once you're done you can get your system totally back to normal with

docker-compose down
docker rmi postgres:latest
docker rmi shrugs/gnarly-test:demo
docker rmi shrugs/paperboy:demo
docker rmi shrugs/wsecho:demo

Description

The postgres image is just vanilla postgres; nothing special.

Gnarly is configured with the erc721, blocks, and events reducers and is in charge of monitoring the blockchain and putting all that nice info in postgres for us.

Paperboy is just a websocket server that queries against the postgres events table for events that match the filter options you provide.

And wsecho is the image that reads the events that the paperboy delivers. It's just a dumb websocket client packaged as a docker container, nothing special.

Note that this docker-compose file exposes paperboy's port (3000) to your host, so you can query it yourself, following the details in the paperboy repo