https://github.com/taxmeifyoucan/preimages

Serves db of geth preimages
https://github.com/taxmeifyoucan/preimages

Last synced: 28 days ago
JSON representation

Serves db of geth preimages

• Host: GitHub
• URL: https://github.com/taxmeifyoucan/preimages
• Owner: taxmeifyoucan
• License: mit
• Created: 2023-02-13T19:04:10.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T05:45:09.000Z (9 months ago)
• Last Synced: 2024-10-28T15:57:27.208Z (3 months ago)
• Language: Python
• Size: 17.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Geth preimages db

Tool for serving [Geth preimages](https://geth.ethereum.org/docs/faq#what-is-a-preimage) as a public database. It returns preimage of a key hash and vice versa. 

You can try it at https://preimages.bordel.wtf or by using the API:  

```

 curl -s -X POST localhost:8000?input=0d2795d4a2e0305f62f46ece58c15a6fa1673779a6a3622640983d644c17625d | jq

{

  "key": "0d2795d4a2e0305f62f46ece58c15a6fa1673779a6a3622640983d644c17625d",

  "preimage": "e83e0b36bc68c1407b81b6d42ca4bd23fc309517",

  "hash": "688ead4f6fe307fa2deceb99132e5d0ef70651acffeeecace94024d2dcacc306"

}

```

## Usage

To run it locally, you will need golang and python. 

First, you need to export preimages from geth. This requires a geth node, ideally with `--cache.preimages` option allowed. Shut down the node and use `db` subcommand for export: 

```

geth db export preimage preimages.rlp

```

Exported data is RLP encoded and to work with it, you need `rlpdump` tool which comes with geth. Compile [`rlpdump` tool from geth repo](https://github.com/ethereum/go-ethereum/) and use it to decode export it preimages. 

```

cd go-ethereum/cmd/rlpdump

go build

cp rlpdump ~/preimages && cd ~/preimages

./rlpdump preimages.rlp > decoded_data

```

Make sure you have python3 and install rest of dependencies:

```

cd preimages

pip3 install -r requirements.txt

```

Before running the API for the first time, run just the program to create a database. Make sure that you created a file with `decoded_data` and it's in the same directory. After this process, you created `preimages.db` file.  

Note that Geth node with all historical preimages retained can reach around 2TB, the RLP export will be around 70GB and resulting sqlite database around 200GB.

Now you can run the API using uvicorn. It's available at localhost:8000. 

```

uvicorn main:app --reload

```