Metadata-Version: 2.1
Name: xchainpy-ethereum
Version: 0.2.0
Summary: Custom Ethereum client and utilities used by XChainPY clients
Home-page: https://github.com/xchainjs/xchainpy-lib/tree/main/xchainpy/xchainpy_ethereum
Author: THORChain
Author-email: 
License: MIT
Description: # `xchainpy/xchainpy_ethereum`
        
        Ethereum Module for XChainPy Clients
        
        ## Modules
        
        - `client` - Custom client for communicating with ethereum-lib
        
        Following dependencies have to be installed into your project
        
        ```
        faster-than-requests==20.10.19
        web3==5.16.0
        websockets==8.1
        ```
        
        ## Service Providers
        
        This package uses ``Infura WSS API``, head to https://infura.io/ to get your own websocket token.
        In addition, if you want to interact with ``non-ERC20 token``, head to https://etherscan.io/ to get your
        etherscan token.
        
        Initialize mainnet client:
        
        ``
        client = Client(phrase="mnemonimic", network="wss://mainnet.infura.io/ws/v3/...", network_type="mainnet",
                                     ether_api="...")
        ``
        
        Initialize ropsten(testnet) client:
        
        ``
        client = Client(phrase="mnemonimic", network="wss://ropsten.infura.io/ws/v3/...", network_type="ropsten",
                                     ether_api="...")
        ``
        
        You can generate mnemonic phrase using ``crypto.py``, head to ``test/test_ropsten_client.py`` to see a
        more comprehensive way to using this client.
        ## Tests
        
        These packages needed to run tests:
        
        - pytest `pip install pytest`
        - pytest-asyncio `pip install pytest-asyncio`
        
        How to run test ?
        
        ``Ropsten``
        ```bash
        $ pytest test/test_ropsten_client.py
        ```
        ``Mainnet``
        ```bash
        $ pytest test/test_mainnet_client.py
        ```
        
        
        
Keywords: ETH,Ethereum,XChainpy_ethereum,THORChain,web3
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
