Skip to content

Commit

Permalink
Update README with more details
Browse files Browse the repository at this point in the history
  • Loading branch information
msf committed Jun 18, 2024
1 parent e231198 commit 3b00d73
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ bin/golangci-lint:
bin/gofumpt: bin
GOBIN=$(PWD)/bin go install mvdan.cc/gofumpt@v0.6.0

build: lint cmd/main.go
build: cmd/main.go
go build -o indexer cmd/main.go

lint: bin/golangci-lint bin/gofumpt
Expand Down
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
# blockchain-ingester
A simple program that ingests blockchain data into Dune
# blockchain node indexer
A program that indexes blockchain data into HTTPS://DUNE.COM by connecting directly to an RPC node

# Limitations

This program works with EVM compatible blockchains, doing direct, EVM-specific JSON-RPC calls to the Node RPC endpoint.


# How to use:

There are only 3 required arguments for running the indexer:
1. DUNE_API_KEY: Your Dune API Key, you can get this at: https://dune.com/settings/api
1. BLOCKCHAIN_NAME: The name of the blockchain as configured on Dune (for example: "ethereum" blockchain)
1. RPC_NODE_URL: The URL of the NODE RPC endpoint, for example: https://sepolia.optimism.io/

For more details see the configuration options section


## Docker Container

You can use our public docker container image and run it as such:

```bash
docker run -e BLOCKCHAIN_NAME='foo' -e RPC_NODE_URL='http://localhost:8545' -e DUNE_API_KEY='your-key-here' duneanalytics/node-indexer

```
BLOCKCHAIN_NAME='foo' RPC_NODE_URL='https://localhost:8545' DUNE_API_KEY='your-key-here' ./indexer



## Binary executable

You can also just build and run a binary executable after cloning this repository:

Build the binary for your OS:
```bash
$ make build

$ BLOCKCHAIN_NAME='foo' RPC_NODE_URL='http://localhost:8545' DUNE_API_KEY='your-key-here' ./indexer

```

## Configuration Options

You can see all the configuration options by using the `--help` argument:
```bash
docker run duneanalytics/node-indexer ./indexer --help

```


0 comments on commit 3b00d73

Please sign in to comment.