Contract Watcher

Requirements

• NodeJS (v15.11.0)
• Postgresql
• geth-statediff
• ipld-eth-indexer
• postgraphile

Application Diagram

Getting Started

• Run geth-statediff with --statediff and --rpcapi "web3,eth,net,debug,personal,statediff" options , e.g.

./geth-statediff --testnet --rpc --rpcapi "web3,eth,net,debug,personal,statediff" --rpccorsdomain '*' --rpcaddr="0.0.0.0" --rpcport="8545" --syncmode=full --statediff --ws --wsaddr="0.0.0.0"

• Run ipld-eth-indexer, e.g.

ETH_WS_PATH=localhost:8546 ./ipld-eth-indexer sync --database-hostname localhost --database-port 5432 --database-password dbpass --database-user dbuser --eth-chain-id 3

• Run postgraphile to expose data from database:

docker run -p 127.0.0.1:5000:5000 -e PG_HOST=pg-host -e PG_PORT=5432 -e PG_DATABASE=vulcanize_public -e PG_USER=dbuser -e PG_PASSWORD=dbpass -e SCHEMA=public,eth vulcanize/postgraphile:v1.0.1

(if you are running postgresql on localhost you need to get local ip address and set it as PG_HOST value)

Run @vulcanize/eth-watcher-ts

cp config.example.toml config.toml
# edit database connections in config.toml
npm i
# run migrations
npm run migrate:up
# sync realtime events
npm run dev

Configure contract address, ABI and events

• Add to table contract.events name of events that you want to watch, e.g.

INSERT INTO contract.events (name) VALUES ('Transfer');
INSERT INTO contract.events (name) VALUES ('Approval');

• Add to table contract.contract information about contract, e.g.

INSERT INTO contract.contracts (name, address, abi, events, methods, starting_block) VALUES ('Uni', '0xbb38B6F181541a6cEdfDac0b94175B2431Aa1A02', 'ABIHERE', '{1,2}', null, 1);

Then generate some events in Smart Contract and it will be populated to data schema in database.

Using the CLI

To add a contract to the watcher database, run the add-contract command:

$ npx ts-node src/cli/add-contract.ts --name Test --address 0x1ca7c995f8eF0A2989BbcE08D5B7Efe50A584aa1 --source-path ./Test.sol --artifact-path ./Test.json

In browser

Build js library

npm run build-browser-lib

Run demo page

1. npm run static-serve
2. Open http://localhost:3000/

How to generate test data

1. connect to server via ssh
2. cd contract-watcher-runner
3. docker-compose exec dapptools sh
4. export ETH_FROM="0x117Db93426Ad44cE9774D239389fcB83057Fc88b"
5. (... seth send ...)

Test HeaderCids

ETH_RPC_ACCOUNTS=1 seth send --gas 0xffff "0xE09af19D2E5254dA6c102da9fc4DdCc5B96856a0" "set(uint)" 42

Test ReceiptCids

ETH_RPC_ACCOUNTS=1 seth send --gas 0xffff 0x40bDf8ed288775f278f5e61E6FDf728bdcaC17A1 'setMessage(string)' '"Hi 2021!"'

Test StateCids

ETH_RPC_ACCOUNTS=1 seth send --gas 0xffff 0x272017314c76110177F4Eac09E04Eb3476788B70 'setA(uint)' 10