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
### Client.get_transaction_by_hash(txn_hash)
> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_gettransactionbyhash
txn_hash: The hex encoded transaction hash to lookup.
Returns a dictionary of the transaction values or None if no transaction is found.
hash: DATA, 32 Bytes - hash of the transaction.
nonce: QUANTITY - the number of transactions made by the sender prior to this one.
blockHash: DATA, 32 Bytes - hash of the block where this transaction was in. null when its pending.
blockNumber: QUANTITY - block number where this transaction was in. null when its pending.
transactionIndex: QUANTITY - integer of the transactions index position in the block. null when its pending.
from: DATA, 20 Bytes - address of the sender.
to: DATA, 20 Bytes - address of the receiver. null when its a contract creation transaction.
value: QUANTITY - value transferred in Wei.
gasPrice: QUANTITY - gas price provided by the sender in Wei.
gas: QUANTITY - gas provided by the sender.
input: DATA - the data send along with the transaction.
### Client.get_block_number()
> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_blocknumber
Returns the number of the most recent block.
### Client.get_accounts()
> https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_accounts
Returns a list of the addresses owned by the client.
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 Distributions
File details
Details for the file ethereum-rpc-client-0.1.3.tar.gz
.
File metadata
- Download URL: ethereum-rpc-client-0.1.3.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 868856bf0dafeabba76d786eebc711ac606bf7a00755276b07980598e4b6bcbd |
|
MD5 | 27d4a94520af84074de7fcb84a798083 |
|
BLAKE2b-256 | 156aa583a63445859a0babeb4fe14f63a80cffe29133fa6337927c485ab09db2 |
File details
Details for the file ethereum_rpc_client-0.1.3-py2-none-any.whl
.
File metadata
- Download URL: ethereum_rpc_client-0.1.3-py2-none-any.whl
- Upload date:
- Size: 6.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51f7ab021e50954682372d0b8860731f1d0a550998618f40eac7db1eff9d556a |
|
MD5 | c1678e3a38b1667361fa66f9bf553cc6 |
|
BLAKE2b-256 | cfeb865460a0b01a8c8754498806b1c88042fd74e69cdcac819da0c36eb04e3f |
File details
Details for the file ethereum-rpc-client-0.1.3.macosx-10.10-x86_64.tar.gz
.
File metadata
- Download URL: ethereum-rpc-client-0.1.3.macosx-10.10-x86_64.tar.gz
- Upload date:
- Size: 3.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 297e7a42b7bfb6832c2210c2bb882d0751112da1c199f717cdf00e47872b1444 |
|
MD5 | 208799110d369ee617eede99739c3a6e |
|
BLAKE2b-256 | 580df3683a012853f8b3656f82e2f87fee095d0186fa45540eadbfb2ab3af934 |