Skip to main content

Ethereum JSON RPC Client

Project description

# Ethereum RPC Client

[![Build Status](https://travis-ci.org/pipermerriam/ethereum-rpc-client.png)](https://travis-ci.org/pipermerriam/ethereum-rpc-client) [![Documentation Status](https://readthedocs.org/projects/ethereum-rpc-client/badge/?version=latest)](https://readthedocs.org/projects/ethereum-rpc-client/?badge=latest) [![PyPi version](https://pypip.in/v/ethereum-rpc-client/badge.png)](https://pypi-hypernode.com/pypi/ethereum-rpc-client) [![PyPi downloads](https://pypip.in/d/ethereum-rpc-client/badge.png)](https://pypi-hypernode.com/pypi/ethereum-rpc-client)

Python client for Ethereum JSON RPC Server

> Note that this currently only implements a handful of the JSON RPC methods > exposed by the server.

## Installation

Install with pip

`bash $ pip install ethereum-rpc-client `

## Basic Usage

Assuming you have an Ethereum node running the JSON RPC server on localhost:8454

`python >>> from eth_rpc_client import Client >>> client = Client(host="127.0.0.1", port="8454") >>> client.get_coinbase() ... '0xd3cda913deb6f67967b99d67acdfa1712c293601' `

## API

### Client.get_coinbase()

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_coinbase

Returns the hex encoded coinbase.

### Client.get_gas_price()

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gasprice

Returns the gas price in wei as an integer

### Client.get_balance(address, block=”latest”)

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getbalance

  • address: The hex encoded address to lookup the balance for.

  • block: The block to use for the lookup.

Returns the account balance for the address in wei as an integer.

### Client.get_code(address, block=”latest”)

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getcode

  • address: The hex encoded address to lookup the code for.

  • block: The block to use for the lookup.

Returns the code at the given address.

### Client.call(_from=None, to=None, gas=None, gas_price=None, value=0, data=None, block=”latest”)

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_call

  • _from: The hex encoded address to use as the source for the call.

  • to: The hex encoded address of the contract for the call.

  • gas: Integer gas alotment for the call.

  • gas_price: Integer gas price in wei.

  • value: Integer amount in wei to send with the call.

  • data: The call data.

Returns the call response.

### Client.get_transaction_receipt(txn_hash)

> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionreceipt

  • txn_hash: The hex encoded transaction hash to lookup.

Returns a dictionary of the transaction receipt or None if no receipt is found.

  • transactionHash: hex encoded hash of the transaction.

  • transactionIndex: integer of the transactions index position in the block.

  • blockHash: hex encoded hash of the block where this transaction was in.

  • blockNumber: integer block number where this transaction was in.

  • cumulativeGasUsed: The total amount of gas used when this transaction was executed in the block.

  • gasUsed: The amount of gas used by this specific transaction alone.

  • contractAddress: The contract address created, if the transaction was a contract creation, otherwise null.

  • logs: list of log objects, which this transaction generated

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ethereum-rpc-client-0.1.1.tar.gz (4.4 kB view details)

Uploaded Source

Built Distributions

ethereum_rpc_client-0.1.1-py2-none-any.whl (5.8 kB view details)

Uploaded Python 2

File details

Details for the file ethereum-rpc-client-0.1.1.tar.gz.

File metadata

File hashes

Hashes for ethereum-rpc-client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a9b82ee56ce4c08b2d2c889b46baa1c85345ee0d80a1bedc9404177fbac24919
MD5 0177212bb0e9e2f278d0ad9ec1618086
BLAKE2b-256 e7c87132713e54b9be8992e1868c82e098fc349a34bd450b1308e7fa20a6051d

See more details on using hashes here.

File details

Details for the file ethereum_rpc_client-0.1.1-py2-none-any.whl.

File metadata

File hashes

Hashes for ethereum_rpc_client-0.1.1-py2-none-any.whl
Algorithm Hash digest
SHA256 bc2da66c4f6ec6f233cf8ea66be8cf54839ca00e760f549ed0337e77300bfa9d
MD5 756a569a69dcdf933d34979cda7ebeff
BLAKE2b-256 b46f542c505feb7acee5919de3d844b2ff5d11eacea73f50144f7745ee19fe55

See more details on using hashes here.

File details

Details for the file ethereum-rpc-client-0.1.1.macosx-10.10-x86_64.tar.gz.

File metadata

File hashes

Hashes for ethereum-rpc-client-0.1.1.macosx-10.10-x86_64.tar.gz
Algorithm Hash digest
SHA256 5a52cf3f4f6ac53592b3f021b4a2fa62665dc1a2a0f037237116ac16bc29be08
MD5 a788ce1095262678301fdce1893030cd
BLAKE2b-256 2c69551332034c1413c16d44c075c5de7492a2c41f57818d158dcf6440ac7695

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page