ape-alchemy: Alchemy provider plugins
Project description
Quick Start
Use the Alchemy provider plugin to interact with blockchains via APIs.
The ape-alchemy plugin supports the following ecosystems:
- Ethereum
- Arbitrum
- Base
- Fantom
- Optimism
- Polygon
- Polygon-ZkEVM
Dependencies
- python3 version 3.9 up to 3.12.
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_IDWEB3_ALCHEMY_API_KEYWEB3_<ecosystem>_<network>_ALCHEMY_PROJECT_IDWEB3_<ecosystem>_<network>_ALCHEMY_PROJECT_ID
For example, to use both Arbitrum and Ethereum in the same session, you could set both WEB3_ARBITRUM_MAINNET_ALCHEMY_PROJECT_ID and WEB3_ETHEREUM_MAINNET_ALCHEMY_PROJECT_ID.
NOTE: If using non-Ethereum networks, take care to install the correct plugins, such as ape-arbitrum, ape-optimism, etc:
ape plugins install arbitrum
Then, 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=<value-of-secret-key>
To use the Alchemy provider plugin in most commands, set it via the --network option:
ape console --network ethereum:sepolia: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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ape-alchemy-0.8.4.tar.gz.
File metadata
- Download URL: ape-alchemy-0.8.4.tar.gz
- Upload date:
- Size: 27.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a8ca475db23597f5cd1df0880a1399815398309eb2cf637288e21bdfead28d95 |
|
| MD5 | ba0d61a7d7844b5475a25ef7b84109ca |
|
| BLAKE2b-256 | c44f6d9ba1079c5940f337dcffd5eac8227e18b25387b4ea62dfeffa5ac73883 |
File details
Details for the file ape_alchemy-0.8.4-py3-none-any.whl.
File metadata
- Download URL: ape_alchemy-0.8.4-py3-none-any.whl
- Upload date:
- Size: 13.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d1cdb9593a7f4e39903075770812c948b4a12e416b8eb058f04ce28298ef2e9f |
|
| MD5 | 2f708bb30b4b5892cc8426e60730526e |
|
| BLAKE2b-256 | 04728974e6b36bb75ce642698a78f90ffe7068dd983c36d7102a49b3727cc162 |
