Skip to main content

Ergonomic python tooling for web3

Project description

Ethereal logo

Ethereal

docs

Ethereal is a lightweight wrapper around the Web3 class that simplifies working with Ethereum smart contracts.

To use it, simply create a regular Web3 instance and write w3 = Ethereal(w3). Then, you can use w3 as usual, but with additional methods accessible under the e property.

For example, you can call w3.e.get_abi("0x...") or w3.e.list_events("0x...", "Mint", "2023-01-01", "2023-02-14").

For more available methods, please refer to the EtherealFacade class.

Demo

Ethereal demo

Example

from web3.auto import w3
from ethereal import Ethereal
from ethereal import load_provider_from_uri

# If WEB3_PROVIDER_URI env is not set, uncomment the lines below
# w3 = Web3(load_provider_from_uri("https://alchemy.com/..."))

w3 = Ethereal(w3)

ADDRESS = "0xB0B195aEFA3650A6908f15CdaC7D92F8a5791B0B"
print(w3.e.list_events(ADDRESS))
# Lists event signatures for the contract at ADDRESS

events = w3.e.get_events(ADDRESS, "Transfer", "2023-01-01", "2023-02-14")
# Gets all Transfer events for the contract at ADDRESS between 2023-01-01 and 2023-02-14
print(events[:10])

Install

pip install ethereal

Supported networks

  • Ethereum
  • Polygon
  • Avalanche
  • Fantom
  • Arbitrum
  • Optimism

Contributing

Feel free to create feature requests or pull requests :D

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

ethereal-0.1.9.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

ethereal-0.1.9-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file ethereal-0.1.9.tar.gz.

File metadata

  • Download URL: ethereal-0.1.9.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for ethereal-0.1.9.tar.gz
Algorithm Hash digest
SHA256 45eeb40b85c92d4605a4877bd464b291a86b978a200c243f4746c3ba784888b0
MD5 1480cd8f3766117c0bd9e81f3836c1fe
BLAKE2b-256 c198f529f5feaf284cccf4f9f1042b6bae8a354c7d42af8d21d8966969935404

See more details on using hashes here.

File details

Details for the file ethereal-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: ethereal-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for ethereal-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e09d32ff2343e9982a5656c29cdc420b5f7230ae94aa95336b964d3e953ddf71
MD5 21c0324009299f0485e6725d56e8aec0
BLAKE2b-256 871514706538a1469d098aaaa0ea7dc4035ea686ef65998a6e95cca1612a78b8

See more details on using hashes here.

Supported by

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