Skip to main content

ape-alchemy: Alchemy Provider plugins for Ethereum-based networks

Project description

Quick Start

Alchemy Provider plugin for Ethereum-based networks.

Dependencies

  • python3 version 3.8 or greater, python3-dev

Installation

via pip

You can install the latest release via pip:

pip install ape-alchemy

via setuptools

You can clone the repository and use setuptools for the most up-to-date version:

git clone https://github.com/ApeWorX/ape-alchemy.git
cd ape-alchemy
python3 setup.py install

Quick Usage

First, make sure you have one of the following environment variables set (it doesn't matter which one):

  • WEB3_ALCHEMY_PROJECT_ID
  • WEB3_ALCHEMY_API_KEY

Either in your current terminal session or in your root RC file (e.g. .bashrc), add the following:

export WEB3_ALCHEMY_PROJECT_ID=MY_API_TOKEN

To use the Alchemy provider plugin in most commands, set it via the --network option:

ape console --network ethereum:goerli:alchemy

To connect to Alchemy from a Python script, use the networks top-level manager:

from ape import networks

with networks.parse_network_choice("ethereum:mainnet:alchemy") as provider:
    ...

Transaction Traces

If you are using a paid tier of Alchemy, you have access to both Geth and Parity style traces. Parity traces are faster and thus are the ones uses in Ethereum receipts' show_trace() method:

from ape import networks

alchemy = networks.provider  # Assuming connected to Alchemy
txn_hash = "0x053cba5c12172654d894f66d5670bab6215517a94189a9ffc09bc40a589ec04d"
receipt = alchemy.get_transaction(txn_hash)
receipt.show_trace()  # Prints the Transaction trace

To access the raw CallTree, do:

from ape import networks

alchemy = networks.provider  # Assuming connected to Alchemy
txn_hash = "0x053cba5c12172654d894f66d5670bab6215517a94189a9ffc09bc40a589ec04d"
call_tree = alchemy.get_call_tree(txn_hash)

To learn more about transaction traces, view Ape's transaction guide.

NOTE: If you require the Geth style traces, you still have access to them via the get_transaction_trace() method and utilities from the evm-trace library:

from evm_trace import CallType, get_calltree_from_geth_trace

from ape import networks

alchemy = networks.provider  # Assuming connected to Alchemy
txn_hash = "0x053cba5c12172654d894f66d5670bab6215517a94189a9ffc09bc40a589ec04d"
receipt = alchemy.get_transaction(txn_hash)
root_node_kwargs = {
    "gas_cost": receipt.gas_used,
    "gas_limit": receipt.gas_limit,
    "address": receipt.receiver,
    "calldata": receipt.data,
    "value": receipt.value,
    "call_type": CallType.CALL,
    "failed": receipt.failed,
}
trace_frame_iter = alchemy.get_transaction_trace(txn_hash)
call_tree = get_calltree_from_geth_trace(trace_frame_iter)

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

ape-alchemy-0.5.0.tar.gz (60.7 kB view details)

Uploaded Source

Built Distribution

ape_alchemy-0.5.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file ape-alchemy-0.5.0.tar.gz.

File metadata

  • Download URL: ape-alchemy-0.5.0.tar.gz
  • Upload date:
  • Size: 60.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.1 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/4.12.0 keyring/23.9.1 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13

File hashes

Hashes for ape-alchemy-0.5.0.tar.gz
Algorithm Hash digest
SHA256 0195b028486e1082fad0135f4f32fd6ee454570882b2feffef691a48b3c994d6
MD5 08e77328c16f22fe9e60e94886527cf2
BLAKE2b-256 4e1c1317941b3833c2a314dd03dd43b7399802804271ac64b4515ab5050597c9

See more details on using hashes here.

File details

Details for the file ape_alchemy-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: ape_alchemy-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.1 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/4.12.0 keyring/23.9.1 rfc3986/2.0.0 colorama/0.4.5 CPython/3.8.13

File hashes

Hashes for ape_alchemy-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96f6011f9662930e4a2332f9b4bdda957d1d82b5ebb5d1861f11e4b51ae8ee7f
MD5 94e6e5b0dc0cfd03ea2ef01140e5e35f
BLAKE2b-256 e51a8f676dddb0eb84a0ec989d9669d570d3bc90debaa84e7ae97972d9959ea0

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