Skip to main content

Tools for exporting Polygon blockchain data to CSV or JSON

Project description

Polygon ETL CLI

Polygon ETL lets you convert blockchain data into convenient formats like CSVs and relational databases.

Full documentation available here.

Quickstart

Install Polygon ETL CLI:

pip3 install polygon-etl

Export blocks, actions and logs (Schema, Reference):

> polygonetl export_blocks_and_transactions --start-block 0 --end-block 500000 \
--provider-uri grpcs://api.mainnet.polygon.one:443 \
--blocks-output blocks.csv --transactions-output transactions.csv

Stream blocks, actions and logs to console (Reference):

> pip3 install polygon-etl[streaming]
> polygonetl stream --start-block 500000 -e block,action,log --log-file log.txt \
--provider-uri grpcs://api.mainnet.polygon.one:443

Find other commands here.

For the latest version, check out the repo and call

> pip3 install -e . 
> python3 polygonetl.py

Useful Links

Running Tests

> pip3 install -r ../requirements_test.txt -e .[streaming]
> export POLYGONETL_RUN_SLOW_TESTS=true
> export POLYGONETL_PROVIDER_URI=grpcs://api.mainnet.polygon.one:443
> pytest -vv

Running Tox Tests

> pip3 install -r ../requirements_test.txt
> export POLYGONETL_RUN_SLOW_TESTS=true
> export POLYGONETL_PROVIDER_URI=grpcs://api.mainnet.polygon.one:443
> tox

Running in Docker

  1. Install Docker https://docs.docker.com/install/

  2. Build a docker image

     > docker build -t polygon-etl:latest .
     > docker image ls
    
  3. Run a container out of the image

     > docker run -v $HOME/output:/polygon-etl/output polygon-etl:latest export_blocks -s 1 -e 5499999 -b 1000 -o out
    
  4. Run streaming to console or Pub/Sub

     > docker build -t polygon-etl:latest -f Dockerfile .
     > echo "Stream to console"
     > docker run polygon-etl:latest stream --start-block 500000 --log-file log.txt
     > echo "Stream to Pub/Sub"
     > docker run -v /path_to_credentials_file/:/polygon-etl/ --env GOOGLE_APPLICATION_CREDENTIALS=/polygon-etl/credentials_file.json polygon-etl:latest stream --start-block 500000 --output projects/<your-project>/topics/mainnet
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polygon-etl-cyberconnect-0.2.1.tar.gz (54.1 kB view details)

Uploaded Source

File details

Details for the file polygon-etl-cyberconnect-0.2.1.tar.gz.

File metadata

File hashes

Hashes for polygon-etl-cyberconnect-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7510d7b13992145f70e116308e34c3f13a096e9d354664941a87ccbc3c91cc21
MD5 0bf1a71ef5da57b0bb5443d2597d897b
BLAKE2b-256 71fa84494e09c59e4020a86d7a949db41a697146fcfe7c0890b203e5781d337d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page