ethvelcro / velcro-node

The Velcro webhook node that consumes the smart contract data, runs queries, and triggers webhooks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[DEPRECATED]

This repo was created for the ETHDenver 2019 Hackathon. We're keeping this available for historical purposes.

The project has been rebranded as Notus. You can refer to the new Notus node Github project.

velcro-node

Build Status

The Velcro node is a server that listens for Ethereum smart contract events or Graph Protocol subscriptions and triggers their corresponding webhooks.

Webhooks can be defined and registered by anyone in a Velcro smart contract. The Velcro node must be configured to point to the deployed smart contract. When webhooks are deregistered from the smart contract the server stops listening to those events.

dependencies

  • node >= 10
  • yarn

setup

yarn

run

yarn dev

test

yarn test

required env vars

See ./env.example for local dev defaultss

PORT               | Port server will bind to for http and websocket traffic
CONTRACT_ADDRESS   | Address for the the contract to monitor for
WS_URL             | Ethereum event subscription url via websocket

deploy

docker

https://hub.docker.com/r/ethvelcro/velcro-node

docker pull ethvelcro/velcro-node:latest

kubernetes

You can find an example deploy configuration that is used for the public server in ./k8s.

About

The Velcro webhook node that consumes the smart contract data, runs queries, and triggers webhooks


Languages

Language:TypeScript 97.5%Language:JavaScript 1.5%Language:Dockerfile 1.0%