skalenetwork / skale.py Goto Github PK

View Code? Open in Web Editor NEW

29.0 6.0 10.0 2.47 MB

Python library for interacting with SKALE Manager

License: GNU Affero General Public License v3.0

Shell 0.58% Python 99.42%

python-library skale-network

skale.py's Introduction

skale.py

Python client library used in SKALE network components.

Python 3.7+ support
Compatibility with web3.py v6

Installation

pip install skale.py

Usage

Supported wallets

Ledger Wallet (works with Ledger Nano S and other models)
RPC Wallet (works with SKALE Transactions Manager)
SGX Wallet (works with SKALE SGX Wallet)
Web3 Wallet (works with web3.py embeded functions)

Library initialization

With embeded Web3Wallet

from skale import SkaleManager
from skale.wallets import Web3Wallet
from skale.utils.web3_utils import init_web3

web3 = init_web3(ENDPOINT)
wallet = Web3Wallet(private_key, web3)
skale = Skale(ENDPOINT, ABI_FILEPATH, wallet)

With external transactions manager:

from skale import SkaleManager
from skale.wallets import RPCWallet

web3 = init_web3(ENDPOINT)
wallet = RPCWallet(TM_URL)
skale = Skale(ENDPOINT, ABI_FILEPATH, wallet)

Interactions with SKALE contracts

active_nodes = skale.nodes.get_active_node_ips()
schains = skale.schains.get_schains_for_owner('0x...')

Working in multiple threads

Due to the web3.py v5 limitations you have to create separate instances of the skale.py for the each thread.
Take a look on the tests/multithreading_test.py for the reference.

Code samples

You can find usage examples here.

Development

Install local version (with hot reload)

virtualenv venv
. venv/bin/activate 
pip install -e .[dev]

Build and publish library

bash build_and_publish.sh major/minor/patch

If you're using .env file

 export $(cat .env | xargs) && bash build_and_publish.sh major/minor/patch

Format your code before commit

Show flake8 errors on file change:

# Test flake8
WHEN_CHANGED_EVENT=file_modified when-changed -v -s -r -1 skale/ tests/ examples/ -c "clear; flake8 web3 tests ens && echo 'flake8 success' || echo 'error'"

Install when-changed:

 pip install https://github.com/joh/when-changed/archive/master.zip

Versioning

The version scheme for this repo is {major}.{minor}.{patch} For more details see: https://semver.org/

Testing

Run local ganache and deploy SKALE Manager:

MANAGER_TAG=... ETH_PRIVATE_KEY=... bash scripts/deploy_manager.sh

Running full test suite:

bash scripts/run_tests.sh

Running test suite manually:

See tests/README.md

License

All contributions are made under the GNU Affero General Public License v3. See LICENSE.

skale.py's People

Contributors

Stargazers

Watchers

Forkers

habeebgit kenman79 ekavikv keytwojohn fullertasha cohoongayl jwitte3 evgeniyzz airdropbaaz

skale.py's Issues

Update connectSchain in skale.py

Schain name: string
schainContracts: address[community_locker_address,token_manager_eth_address,token_manager_erc20_address,token_manager_erc721_address]

┆Issue is synchronized with this Jira Task

Add type hints

To improve code quality and avoid mistakes we should enforce mypy checks in every python repository.

Tasks

Beta Give feedback

Add chain ID in skale.py (for using geth >1.10)

Critical to do it before Berlin fork on mainnet
Geth v1.10.1 will reject transactions on the RPC that are not replay protected

┆Issue is synchronized with this Jira Bug

Add cla-assistant github action

Tasks

Beta Give feedback

Add Mainnet IMA contracts to python library skale-contracts#32

1 of 1

epic:skale-contracts
Add schain IMA contracts to python library skale-contracts#34

epic:skale-contracts
Add skale-allocator contracts to the python library skale-contracts#52
Options

Update skale admin to latest IMA

[2021-05-06 14:37:55,255 INFO] tools.notifications.messages:119 - ThreadPoolExecutor-0_0 - Saving new checks state 167 [('blocks', True), ('config', True), ('container', True), ('data_dir', True), ('dkg', True), ('exit_code_ok', True), ('firewall_rules', True), ('ima_container', False), ('rpc', True), ('volume', True)]
[2021-05-06 14:37:55,256 INFO] web.models.schain:102 - ThreadPoolExecutor-0_0 - Changing first_run for shapely-zavijah to False
[2021-05-06 14:37:55,261 INFO] web.models.schain:112 - ThreadPoolExecutor-0_0 - Changing new_schain for shapely-zavijah to False
[2021-05-06 14:37:55,265 INFO] core.schains.creator:201 - ThreadPoolExecutor-0_0 - Running monitor for sChain shapely-zavijah in REGULAR mode
[2021-05-06 14:37:56,780 WARNING] tools.docker_utils:128 - ThreadPoolExecutor-0_0 - Can not get info - no such container: skale_ima_shapely-zavijah
[2021-05-06 14:37:56,781 ERROR] core.schains.creator:161 - ThreadPoolExecutor-0_0 - Monitor for sChain shapely-zavijah failed
Traceback (most recent call last):
File "/usr/local/lib/python3.8/site-packages/skale/utils/abi_utils.py", line 42, in get_abi_key
return abi[key]
KeyError: 'lock_and_data_for_mainnet_address'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "/usr/src/admin/core/schains/creator.py", line 158, in run_monitor_for_schain
monitor_schain(
File "/usr/src/admin/core/schains/creator.py", line 245, in monitor_schain
monitor_checks(
File "/usr/src/admin/core/schains/creator.py", line 396, in monitor_checks
monitor_ima(skale_ima, schain, mainnet_chain_id)
File "/usr/src/admin/core/schains/creator.py", line 400, in monitor_ima
if skale_ima.lock_and_data_for_mainnet.has_schain(schain['name']):
File "/usr/local/lib/python3.8/site-packages/skale/skale_base.py", line 127, in getattr
self.__init_contract_from_info(abi, contract_info)
File "/usr/local/lib/python3.8/site-packages/skale/skale_base.py", line 93, in __init_contract_from_info
self.add_lib_contract(contract_info.name, contract_info.contract_class,
File "/usr/local/lib/python3.8/site-packages/skale/skale_base.py", line 103, in add_lib_contract
address = contract_address or get_contract_address_by_name(
File "/usr/local/lib/python3.8/site-packages/skale/utils/abi_utils.py", line 48, in get_contract_address_by_name
return get_abi_key(abi, get_address_key_name(name))
File "/usr/local/lib/python3.8/site-packages/skale/utils/abi_utils.py", line 44, in get_abi_key
raise IncompatibleAbiError(key)
skale.utils.exceptions.IncompatibleAbiError: Required field was not found in the ABI file: lock_and_data_for_mainnet_address
[2021-05-06 14:37:56,782 INFO] core.schains.creator:132 - MainThread - Creator procedure finished
[2021-05-06 14:37:56,786 INFO] core.schains.creator:87 - MainThread - Creator process is joined.
[2021-05-06 14:37:56,786 INFO] core.schains.creator:88 - MainThread - Terminating the process
Sleeping for 10s ...
[2021-05-06 14:38:06,799 INFO] core.schains.cleaner:57 - MainThread - Cleaner process started

Changes:
Before:
MessageProxyForMainnet
LockAndDataForMainnet
LockAndDataForMainnetERC20
LockAndDataForMainnetERC721
ERC20ModuleForMainnet
ERC721ModuleForMainnet
DepositBox

After:
MessageProxyForMainnet
IMALinker
DepositBox
DepositBoxERC20
DepositBoxERC721

┆Issue is synchronized with this Jira Task

Pass custom owner to create sChain by foundation

On skale-manager it's possible to set custom sChain owner when creating a sChain by the foundation. The same functionality should be available in skale.py

┆Issue is synchronized with this Jira Task

Upgrade to use python 3.11

We're currently using Python 3.7 for most of our repos (release date: 2018-06-27 with the end of support 2023-06-27).
Lots of performance improvements were introduces since then, for example:

CPython 3.11 is on average 25% faster than CPython 3.10 when measured with the pyperformance benchmark suite, and compiled with GCC on Ubuntu Linux. Depending on your workload, the speedup could be up to 10-60% faster.

Upgrading Python to 3.11 shouldn't break anything for our customers, since all code will be used in docker containers.

Multiple retries and sleep during dry run failure on transaction-manager

Currently, when dry run fails on transaction-manager side, skale.py does lots of retries because of the failed RPC request. This behaviour should be modified to properly handle failed dry run.

┆Issue is synchronized with this Jira Bug

Update gas price strategy to avoid low gas price issue

See more details here: https://skalelabs.atlassian.net/wiki/spaces/SKALE/pages/2141159472/getBounty+issue+-+June+2021

Web3 gas price API: https://web3py.readthedocs.io/en/stable/gas_price.html

┆Issue is synchronized with this Jira Task

Improve EthClientOutdatedError in the skale.py

EthClientOutdatedError currently thrown in 2 cases:

diff in time on the machine and latest block is bigger than allowed_ts_diff
if latest block ts is lower that the one saved in the state_path for this component

In both cases, detailed info should be logged. Also we should cover the case when time on the machine is less than ts of the latest block.

┆Issue is synchronized with this Jira Task

skalenetwork / skale.py Goto Github PK

skale.py's Introduction

skale.py

Installation

Usage

Supported wallets

Library initialization

Working in multiple threads

Code samples

Development

Install local version (with hot reload)

Build and publish library

If you're using .env file

Format your code before commit

Versioning

Testing

License

skale.py's People

Contributors

Stargazers

Watchers

Forkers

skale.py's Issues

Tasks

Tasks

Recommend Projects

Recommend Topics

Recommend Org