mirror of
https://github.com/autistic-symposium/blockchain-data-engineering-toolkit.git
synced 2025-04-26 02:39:15 -04:00
98 lines
2.3 KiB
Markdown
98 lines
2.3 KiB
Markdown
## 🛠🪙 token scanner api and cli
|
||
|
||
<br>
|
||
|
||
##### 👉 this project implements a cli tool that indexes transfer events for a particular token, and is deployed to a restful api for fast balance and ownership statistics retrieval. it utilizes [JSON-RPC methods](https://docs.infura.io/infura/networks/ethereum/json-rpc-methods/eth_getlogs) `eth_blockNumber` and `eth_getLogs`.
|
||
|
||
##### 🛠 system design for this project:
|
||
|
||
|
||
|
||
##### 📚 more details can be found in my mirror post, **[quant #3: building a scalable event scanner for ethereum](https://mirror.xyz/steinkirch.eth/vSF18xcLyfXLIWwxjreRa3I_XskwgnjSc6pScegNJWI)**.
|
||
|
||
|
||
<br>
|
||
|
||
---
|
||
|
||
### setting up
|
||
|
||
<br>
|
||
|
||
#### installing dependencies
|
||
|
||
because of some of the dependencies in this code, we will be developing on a python3.9 environment (install here if you don’t have that version on disk):
|
||
|
||
```
|
||
virtualenv -p /usr/local/bin/python3.9 venv
|
||
source venv/bin/activate
|
||
pip3 install -r requirements.txt
|
||
```
|
||
|
||
|
||
<br>
|
||
|
||
#### adding environment variables
|
||
|
||
create a `.env` file and add an `RPC_PROVIDER_URL` to connect to ethereum mainnet nodes (for example, from [this list](https://ethereumnodes.com/)):
|
||
|
||
```
|
||
cp .env.example .env
|
||
vim .env
|
||
```
|
||
|
||
<br>
|
||
|
||
#### installing the package
|
||
|
||
```
|
||
make install
|
||
```
|
||
|
||
<br>
|
||
|
||
----
|
||
|
||
### running
|
||
|
||
<br>
|
||
|
||
|
||
```
|
||
indexer -h
|
||
|
||
🪙 Token indexer and API.
|
||
|
||
optional arguments:
|
||
-h, --help show this help message and exit
|
||
-e Retrieve historical transfer events data on Ethereum. Example: indexer -e
|
||
-p PROCESS Process historical transfer events data. Example: indexer -p <json data file>
|
||
-d DB Populate db with processed event data. Example: indexer -d <json data file>
|
||
-a Run the event scanner api locally. Example: indexer -a
|
||
-c Deploy event scanner to Vercel. Example: indexer -c
|
||
-b BALANCE Fetch token balance for a given wallet. Example: indexer -b <wallet address>
|
||
-t TOP Fetch top token holders. Example: indexer -t <number of holders>
|
||
-g CHANGE Fetch weekly balance change for a given wallet. Example: indexer -g <wallet address>
|
||
```
|
||
|
||
|
||
<br>
|
||
|
||
---
|
||
|
||
### development
|
||
|
||
<br>
|
||
|
||
#### deploying in production
|
||
|
||
we use vercel to deploy this app:
|
||
|
||
```
|
||
vercel login
|
||
vercel .
|
||
```
|
||
|
||
<br>
|
||
|