https://github.com/sjonhortensius/toobasic-ethereum
A very basic Ethereum client for PHP; with strict argument and returntypes
https://github.com/sjonhortensius/toobasic-ethereum
ethereum php php-library php7 rpc-client
Last synced: 2 months ago
JSON representation
A very basic Ethereum client for PHP; with strict argument and returntypes
- Host: GitHub
- URL: https://github.com/sjonhortensius/toobasic-ethereum
- Owner: SjonHortensius
- Created: 2017-07-16T11:28:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-19T12:37:32.000Z (over 5 years ago)
- Last Synced: 2025-02-08T15:46:46.145Z (4 months ago)
- Topics: ethereum, php, php-library, php7, rpc-client
- Language: PHP
- Size: 30.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TooBasic-Ethereum
A very basic Ethereum client for PHP; with strict typehints for arguments and return values, for more info on methods see the [RPC documentation](https://github.com/paritytech/parity/wiki/JSONRPC-eth-module).
Based on the [schema description in ethjs](https://github.com/SjonHortensius/ethjs-schema/blob/67c3badad07b72649f057a3f7d6039b4d01a03d2/src/schema.json) this client offers a way to connect to any [parity](https://github.com/ethcore/parity) or [geth](https://github.com/ethereum/go-ethereum/) server using PHP.
## Example usage:
```php
// Simple autoloader to find Ethereum & Rpc client
spl_autoload_register(function($class){
$class = str_replace('\\', '/', $class);
if (0 === strpos($class, 'TooBasic/Ethereum/'))
require('TooBasic-Ethereum/'. substr($class, strlen('TooBasic/Ethereum/')) .'.php');
elseif (0 === strpos($class, 'TooBasic/Rpc/'))
require('TooBasic-Rpc/'. substr($class, strlen('TooBasic/Rpc/')) .'.php');
elseif (file_exists($class .'.php'))
require($class .'.php');
});
// Setup an RPC connection with a curl transport
$curl = new TooBasic\Rpc\Transport\Curl;
self::$client = new TooBasic\Ethereum\Client('http://127.0.0.1:8546', $curl);
self::$client->setNamedParameters(false);
// You can call any method your ethereum node supports
var_dump('Local sync-status: ', self::$client->eth_syncing());
var_dump('Local last-block:', self::$client->eth_blockNumber());
var_dump('Foundation tip-jar balance (in wei):', self::$client->eth_getBalance(
new Schema\Primitive\Bytes20('fB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'),
new Schema\Primitive\QuantityOrTag(Schema\Tag::LATEST)
));
// Show the contents of a complete block including all transactions:
var_dump(self::$client->eth_getBlockByNumber(new Schema\Primitive\QuantityOrTag(dechex(4000000)), true));
```
## Supported primitives:
* Bytes / Bytes20 / Bytes32
* Quantity / PaddedQuantity (with `bcmath` / `gmp` as backend for large numbers)
* boolean - supported by using native PHP booleans
* string - supported by using native PHP booleans
Since the API has a few methods that require or return different primitives, we have 3 wrappers to represent those:
* BooleanOrEthSyncing
* ArrayOrData
* QuantityOrTag
## Supported tag
The RPC describes a single Tag Type which is neither a Primitive nor an Object
* Tag - a wrapper for the latest/earliest/pending tag
## Supported objects:
Since I parse the schema and generate all objects dynamically, this means you can [regenerate all Objects](https://github.com/SjonHortensius/TooBasic-Ethereum/blob/master/ClientGenerator.php) using `php ClientGenerator.php`. Currently this generates:
* EthSyncing
* Block
* Receipt
* Transaction
* CallTransaction
* EstimateTransaction
* SendTransaction
* Filter
* FilterChange
* SHHMessage
* SHHPost
* SHHFilterChange
* SHHFilter