Safe Ecosystem Foundation utilities for Ethereum projects
Project description
- Safe-eth-py includes a set of libraries to work with Ethereum and relevant Ethereum projects:
EthereumClient, a wrapper over Web3.py Web3 client including utilities to deal with ERC20/721 tokens and tracing.
Safe classes and utilities.
Price oracles for Uniswap, Kyber…
Django serializers, models and utils.
Quick start
Just run pip install safe-eth-py or add it to your requirements.txt
If you want django ethereum utils (models, serializers, filters…) you need to run pip install safe-eth-py[django]
If you have issues building coincurve maybe you are missing some libraries
Contributing to safe-eth-py
Clone the repo, then to set it up:
python -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt
pre-commit install -f
Add new address for new chains
If you want to add Safe Smart Account support for a new chain you must open a new issue.
Once the issue is created or edited, an automatic validation will be executed and a Pull Request will be created if everything is ok. Finally, the Safe team will review and merge the automatic Pull Request generated from the issue.
Ethereum utils
safe_eth.eth
class EthereumClient (ethereum_node_url: str): Class to connect and do operations with an ethereum node. Uses web3 and raw rpc calls for things not supported in web3. Only http/https urls are supported for the node url.
EthereumClient has some utils that improve a lot performance using Ethereum nodes, like the possibility of doing batch_calls (a single request making read-only calls to multiple contracts):
from safe_eth.eth import EthereumClient
from safe_eth.eth.contracts import get_erc721_contract
ethereum_client = EthereumClient(ETHEREUM_NODE_URL)
erc721_contract = get_erc721_contract(self.w3, token_address)
name, symbol = ethereum_client.batch_call([
erc721_contract.functions.name(),
erc721_contract.functions.symbol(),
])
If you want to use the underlying web3.py library:
from safe_eth.eth import EthereumClient
ethereum_client = EthereumClient(ETHEREUM_NODE_URL)
ethereum_client.w3.eth.get_block(57)
safe_eth.eth.constants
NULL_ADDRESS (0x000...0): Solidity address(0).
SENTINEL_ADDRESS (0x000...1): Used for Safe’s linked lists (modules, owners…).
Maximum and minimum values for R, S and V in ethereum signatures.
safe_eth.eth.oracles
Price oracles for Uniswap, UniswapV2, Kyber, SushiSwap, Aave, Balancer, Curve, Mooniswap, Yearn… Example:
from safe_eth.eth import EthereumClient
from safe_eth.eth.oracles import UniswapV2Oracle
ethereum_client = EthereumClient(ETHEREUM_NODE_URL)
uniswap_oracle = UniswapV2Oracle(ethereum_client)
gno_token_mainnet_address = '0x6810e776880C02933D47DB1b9fc05908e5386b96'
weth_token_mainnet_address = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
price = uniswap_oracle.get_price(gno_token_mainnet_address, uniswap_oracle.weth_address)
safe_eth.eth.utils
Contains utils for ethereum operations:
mk_contract_address_2(from_: Union[str, bytes], salt: Union[str, bytes], init_code: [str, bytes]) -> str: Calculates the address of a new contract created using the new CREATE2 opcode.
Ethereum django (REST) utils
Django utils are available under safe_eth.eth.django. You can find a set of helpers for working with Ethereum using Django and Django Rest framework.
It includes:
safe_eth.eth.django.filters: EthereumAddressFilter.
safe_eth.eth.django.models: Model fields (Ethereum address, Ethereum big integer field).
safe_eth.eth.django.serializers: Serializer fields (Ethereum address field, hexadecimal field).
safe_eth.eth.django.validators: Ethereum related validators.
safe_eth.safe.serializers: Serializers for Safe (signature, transaction…).
All the tests are written using Django Test suite.
Contributors
Project details
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
Hashes for safe_eth_py-6.0.0b37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f34cf13266e407d8be3ce1af92f3e799c4f4ab524a07f0c0933d4faf5a87d7f6 |
|
MD5 | 34b06aa9819bb5c904255b4c87df137f |
|
BLAKE2b-256 | bf84c3066da29101fe7a5bd156f79934dc96667e271daeaecea2aedf860973c1 |