safe-pls-py (previosly known as Gnosis-py)
##########################################
.. class:: no-web no-pdf
|ci| |coveralls| |python| |django| |pipy| |readthedocs| |black|
safe-pls-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.
- `Gnosis Safe <https://github.com/safe-global/safe-contracts>`_ classes and utilities.
- Price oracles for `Uniswap`, `Kyber`...
- Django serializers, models and utils.
Quick start
-----------
Just run ``pip install safe-pls-py`` or add it to your **requirements.txt**
If you want django ethereum utils (models, serializers, filters...) you need to run
``pip install safe-pls-py[django]``
If you have issues building **coincurve** maybe
`you are missing some libraries <https://ofek.dev/coincurve/install/#source>`_
Contributing to safe-pls-py
---------------------------
Clone the repo, then to set it up:
.. code-block:: bash
python -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt
pre-commit install -f
Ethereum utils
--------------
gnosis.eth
~~~~~~~~~~~~~~~~~~~~
- ``class EthereumClient (ethereum_node_url: str)``: Class to connect and do operations
with a ethereum node. Uses web3 and raw rpc calls for things not supported in web3.
Only ``http/https`` urls are suppored 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):
.. code-block:: python
from gnosis.eth import EthereumClient
from gnosis.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 <https://github.com/ethereum/web3.py>`_ library:
.. code-block:: python
from gnosis.eth import EthereumClient
ethereum_client = EthereumClient(ETHEREUM_NODE_URL)
ethereum_client.w3.eth.get_block(57)
gnosis.eth.constants
~~~~~~~~~~~~~~~~~~~~
- ``NULL_ADDRESS (0x000...0)``: Solidity ``address(0)``.
- ``SENTINEL_ADDRESS (0x000...1)``: Used for Gnosis Safe's linked lists (modules, owners...).
- Maximum an minimum values for `R`, `S` and `V` in ethereum signatures.
gnosis.eth.oracles
~~~~~~~~~~~~~~~~~~
Price oracles for Uniswap, UniswapV2, Kyber, SushiSwap, Aave, Balancer, Curve, Mooniswap, Yearn...
Example:
.. code-block:: python
from gnosis.eth import EthereumClient
from gnosis.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)
gnosis.eth.utils
~~~~~~~~~~~~~~~~
Contains utils for ethereum operations:
- ``get_eth_address_with_key() -> Tuple[str, bytes]``: Returns a tuple of a valid public ethereum checksumed
address with the private key.
- ``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 ``gnosis.eth.django``.
You can find a set of helpers for working with Ethereum using Django and Django Rest framework.
It includes:
- **gnosis.eth.django.filters**: EthereumAddressFilter.
- **gnosis.eth.django.models**: Model fields (Ethereum address, Ethereum big integer field).
- **gnosis.eth.django.serializers**: Serializer fields (Ethereum address field, hexadecimal field).
- **gnosis.eth.django.validators**: Ethereum related validators.
- **gnosis.safe.serializers**: Serializers for Gnosis Safe (signature, transaction...).
- All the tests are written using Django Test suite.
Contributors
------------
`See contributors <https://github.com/safe-global/safe-pls-py/graphs/contributors>`_
.. |ci| image:: https://github.com/safe-global/safe-pls-py/workflows/Python%20CI/badge.svg?branch=master
:alt: Github Actions CI build
.. |coveralls| image:: https://coveralls.io/repos/github/safe-global/safe-pls-py/badge.svg?branch=master
:target: https://coveralls.io/github/safe-global/safe-pls-py?branch=master
:alt: Coveralls
.. |python| image:: https://img.shields.io/badge/Python-3.9-blue.svg
:alt: Python 3.9
.. |django| image:: https://img.shields.io/badge/Django-2-blue.svg
:alt: Django 2.2
.. |pipy| image:: https://badge.fury.io/py/safe-pls-py.svg
:target: https://badge.fury.io/py/safe-pls-py
:alt: Pypi package
.. |readthedocs| image:: https://readthedocs.org/projects/safe-pls-py/badge/?version=latest
:target: https://safe-pls-py.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
Raw data
{
"_id": null,
"home_page": "https://github.com/johnny-vu/safe-pls-py",
"name": "safe-pls-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ethereum,web3,django,safe,cowswap,gnosis",
"author": "Ux\u00edo",
"author_email": "uxio@safe.global",
"download_url": "https://files.pythonhosted.org/packages/f4/41/c02df2091babbc6be075c68c9913035699c7b401adb2947c1084d98b24fb/safe-pls-py-5.4.3.tar.gz",
"platform": null,
"description": "safe-pls-py (previosly known as Gnosis-py)\n##########################################\n\n.. class:: no-web no-pdf\n\n|ci| |coveralls| |python| |django| |pipy| |readthedocs| |black|\n\nsafe-pls-py includes a set of libraries to work with Ethereum and relevant Ethereum projects:\n - `EthereumClient`, a wrapper over Web3.py `Web3` client including utilities to deal with ERC20/721\n tokens and tracing.\n - `Gnosis Safe <https://github.com/safe-global/safe-contracts>`_ classes and utilities.\n - Price oracles for `Uniswap`, `Kyber`...\n - Django serializers, models and utils.\n\nQuick start\n-----------\n\nJust run ``pip install safe-pls-py`` or add it to your **requirements.txt**\n\nIf you want django ethereum utils (models, serializers, filters...) you need to run\n``pip install safe-pls-py[django]``\n\nIf you have issues building **coincurve** maybe\n`you are missing some libraries <https://ofek.dev/coincurve/install/#source>`_\n\n\nContributing to safe-pls-py\n---------------------------\nClone the repo, then to set it up:\n\n.. code-block:: bash\n\n python -m venv venv\n source venv/bin/activate\n pip install -r requirements-dev.txt\n pre-commit install -f\n\nEthereum utils\n--------------\ngnosis.eth\n~~~~~~~~~~~~~~~~~~~~\n- ``class EthereumClient (ethereum_node_url: str)``: Class to connect and do operations\n with a ethereum node. Uses web3 and raw rpc calls for things not supported in web3.\n Only ``http/https`` urls are suppored for the node url.\n\n``EthereumClient`` has some utils that improve a lot performance using Ethereum nodes, like\nthe possibility of doing ``batch_calls`` (a single request making read-only calls to multiple contracts):\n\n.. code-block:: python\n\n from gnosis.eth import EthereumClient\n from gnosis.eth.contracts import get_erc721_contract\n ethereum_client = EthereumClient(ETHEREUM_NODE_URL)\n erc721_contract = get_erc721_contract(self.w3, token_address)\n name, symbol = ethereum_client.batch_call([\n erc721_contract.functions.name(),\n erc721_contract.functions.symbol(),\n ])\n\nIf you want to use the underlying `web3.py <https://github.com/ethereum/web3.py>`_ library:\n\n.. code-block:: python\n\n from gnosis.eth import EthereumClient\n ethereum_client = EthereumClient(ETHEREUM_NODE_URL)\n ethereum_client.w3.eth.get_block(57)\n\n\ngnosis.eth.constants\n~~~~~~~~~~~~~~~~~~~~\n- ``NULL_ADDRESS (0x000...0)``: Solidity ``address(0)``.\n- ``SENTINEL_ADDRESS (0x000...1)``: Used for Gnosis Safe's linked lists (modules, owners...).\n- Maximum an minimum values for `R`, `S` and `V` in ethereum signatures.\n\ngnosis.eth.oracles\n~~~~~~~~~~~~~~~~~~\n\nPrice oracles for Uniswap, UniswapV2, Kyber, SushiSwap, Aave, Balancer, Curve, Mooniswap, Yearn...\nExample:\n\n.. code-block:: python\n\n from gnosis.eth import EthereumClient\n from gnosis.eth.oracles import UniswapV2Oracle\n ethereum_client = EthereumClient(ETHEREUM_NODE_URL)\n uniswap_oracle = UniswapV2Oracle(ethereum_client)\n gno_token_mainnet_address = '0x6810e776880C02933D47DB1b9fc05908e5386b96'\n weth_token_mainnet_address = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'\n price = uniswap_oracle.get_price(gno_token_mainnet_address, uniswap_oracle.weth_address)\n\n\n\ngnosis.eth.utils\n~~~~~~~~~~~~~~~~\n\nContains utils for ethereum operations:\n\n- ``get_eth_address_with_key() -> Tuple[str, bytes]``: Returns a tuple of a valid public ethereum checksumed\n address with the private key.\n- ``mk_contract_address_2(from_: Union[str, bytes], salt: Union[str, bytes], init_code: [str, bytes]) -> str``:\n Calculates the address of a new contract created using the new CREATE2 opcode.\n\nEthereum django (REST) utils\n----------------------------\nDjango utils are available under ``gnosis.eth.django``.\nYou can find a set of helpers for working with Ethereum using Django and Django Rest framework.\n\nIt includes:\n\n- **gnosis.eth.django.filters**: EthereumAddressFilter.\n- **gnosis.eth.django.models**: Model fields (Ethereum address, Ethereum big integer field).\n- **gnosis.eth.django.serializers**: Serializer fields (Ethereum address field, hexadecimal field).\n- **gnosis.eth.django.validators**: Ethereum related validators.\n- **gnosis.safe.serializers**: Serializers for Gnosis Safe (signature, transaction...).\n- All the tests are written using Django Test suite.\n\nContributors\n------------\n`See contributors <https://github.com/safe-global/safe-pls-py/graphs/contributors>`_\n\n.. |ci| image:: https://github.com/safe-global/safe-pls-py/workflows/Python%20CI/badge.svg?branch=master\n :alt: Github Actions CI build\n\n.. |coveralls| image:: https://coveralls.io/repos/github/safe-global/safe-pls-py/badge.svg?branch=master\n :target: https://coveralls.io/github/safe-global/safe-pls-py?branch=master\n :alt: Coveralls\n\n.. |python| image:: https://img.shields.io/badge/Python-3.9-blue.svg\n :alt: Python 3.9\n\n.. |django| image:: https://img.shields.io/badge/Django-2-blue.svg\n :alt: Django 2.2\n\n.. |pipy| image:: https://badge.fury.io/py/safe-pls-py.svg\n :target: https://badge.fury.io/py/safe-pls-py\n :alt: Pypi package\n\n.. |readthedocs| image:: https://readthedocs.org/projects/safe-pls-py/badge/?version=latest\n :target: https://safe-pls-py.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Safe Ecosystem Foundation utilities for Ethereum projects",
"version": "5.4.3",
"project_urls": {
"Documentation": "https://safe-pls-py.readthedocs.io/en/latest/",
"Homepage": "https://github.com/johnny-vu/safe-pls-py",
"Source": "https://github.com/safe-global/safe-pls-py",
"Tracker": "https://github.com/safe-global/safe-pls-py/issues"
},
"split_keywords": [
"ethereum",
"web3",
"django",
"safe",
"cowswap",
"gnosis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bc833de1ee67bdd27c125772b4ca1eb67a00b6db8fe3cfad3577e2b4fde018d",
"md5": "9509d1699630c5470154f1027307b113",
"sha256": "8e4165d67e942816ae595fbc14dbd498ec8bdbffe4e53e75e14cf74474ab6c14"
},
"downloads": -1,
"filename": "safe_pls_py-5.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9509d1699630c5470154f1027307b113",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 759215,
"upload_time": "2023-06-17T15:45:08",
"upload_time_iso_8601": "2023-06-17T15:45:08.617092Z",
"url": "https://files.pythonhosted.org/packages/8b/c8/33de1ee67bdd27c125772b4ca1eb67a00b6db8fe3cfad3577e2b4fde018d/safe_pls_py-5.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f441c02df2091babbc6be075c68c9913035699c7b401adb2947c1084d98b24fb",
"md5": "3249b0d78f1023c1449182e89e7cbab2",
"sha256": "b636bca989ce571200829b4da1e05e4817a76be44ad8c2d11dc91648c5e3b408"
},
"downloads": -1,
"filename": "safe-pls-py-5.4.3.tar.gz",
"has_sig": false,
"md5_digest": "3249b0d78f1023c1449182e89e7cbab2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 685727,
"upload_time": "2023-06-17T15:45:16",
"upload_time_iso_8601": "2023-06-17T15:45:16.796084Z",
"url": "https://files.pythonhosted.org/packages/f4/41/c02df2091babbc6be075c68c9913035699c7b401adb2947c1084d98b24fb/safe-pls-py-5.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-17 15:45:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "johnny-vu",
"github_project": "safe-pls-py",
"github_not_found": true,
"lcname": "safe-pls-py"
}
JSON
