Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitaldonkey/ethereum-php
PHP interface to Ethereum JSON-RPC API. Fully typed Web3 for PHP 7.X
https://github.com/digitaldonkey/ethereum-php
ethereum ethereum-client ethereum-php ethereum-php-library php php-interface smart-contracts web3 web3-php web3php
Last synced: 19 days ago
JSON representation
PHP interface to Ethereum JSON-RPC API. Fully typed Web3 for PHP 7.X
- Host: GitHub
- URL: https://github.com/digitaldonkey/ethereum-php
- Owner: digitaldonkey
- License: mit
- Created: 2017-02-23T22:28:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-13T13:14:29.000Z (about 1 year ago)
- Last Synced: 2024-10-05T11:22:18.692Z (about 1 month ago)
- Topics: ethereum, ethereum-client, ethereum-php, ethereum-php-library, php, php-interface, smart-contracts, web3, web3-php, web3php
- Language: PHP
- Homepage: http://ethereum-php.org
- Size: 1.92 MB
- Stars: 489
- Watchers: 29
- Forks: 175
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- DeFi-Developer-Road-Map - Ethereum-php - PHP Web3 (Roadmap)
README
# Ethereum-PHP
is a typed PHP-7.1+ interface to [Ethereum JSON-RPC API](https://github.com/ethereum/wiki/wiki/JSON-RPC).
Check out the latest [API documentation](http://ethereum-php.org/dev/).
### Add library in a [composer.json](https://getcomposer.org/doc/01-basic-usage.md#composer-json-project-setup) file
```yaml
{
"minimum-stability":"dev",
"autoload": {
"psr-4": {
"Ethereum\\": "src/"
}
},
"repositories": [
{
"type": "git",
"url": "https://github.com/digitaldonkey/ethereum-php.git"
}
],
"require": {
"digitaldonkey/ethereum-php": "dev-master"
}
}
```
### Usage
```sh
composer require digitaldonkey/ethereum-php
```
This is the important part of [composer.json](https://github.com/digitaldonkey/ethereum/blob/8.x-1.x/composer.json) in [Drupal Ethereum Module](https://drupal.org/project/ethereum).
```php
require __DIR__ . '/vendor/autoload.php';
use Ethereum\Ethereum;
try {
// Connect to Ganache
$eth = new Ethereum('http://127.0.0.1:7545');
// Should return Int 63
echo $eth->eth_protocolVersion()->val();
}
catch (\Exception $exception) {
die ("Unable to connect.");
}
```
**Calling Contracts**
You can call (unpayed) functions in smart contracts easily.
The json file "$fileName" used is what you get when you compile a contract with [Truffle](truffleframework.com).
```php
$ContractMeta = json_decode(file_get_contents($fileName));
$contract = new SmartContract(
$ContractMeta->abi,
$ContractMeta->networks->{NETWORK_ID}->address,
new Ethereum(SERVER_URL)
);
$someBytes = new EthBytes('34537ce3a455db6b')
$x = $contract->myContractMethod();
echo $x->val()
```
You can also run tests at smart contracts, check out EthTestClient.
### Event listening and handling
You can use Ethereum-PHP to watch changed on your smart contracts or index a Blockchain block by block. gs
See [UsingFilters](https://github.com/digitaldonkey/ethereum-php/blob/master/UsingFilters.md) and [ethereum-php-eventlistener](https://github.com/digitaldonkey/ethereum-php-eventlistener).
### Limitations
Currently not all datatypes are supported.
This library is read-only for now. This means you can retrieve information stored in Ethereum Blockchain.
To *write* to the blockchain you need a to sign transactions with a private key which is not supported yet.
### Documentation
The API documentation is available at [ethereum-php.org](http://ethereum-php.org/).
For reference see the [Ethereum RPC documentation](https://github.com/ethereum/wiki/wiki/JSON-RPC) and for data encoding [RLP dcumentation](https://github.com/ethereum/wiki/wiki/RLP) in [Ethereum Wiki](https://github.com/ethereum/wiki).
There is also a more readable [Ethereum Frontier Guide](http://ethereum.gitbooks.io/frontier-guide/content/rpc.html) version.