web3-plus.php

A php interface for interacting with the Ethereum blockchain and ecosystem.

Install

Set minimum stability to dev

"minimum-stability": "dev"

Then

composer require chuangyeshuo/web3-plus.php dev-master

Or you can add this line in composer.json

"chuangyeshuo/web3-plus.php": "dev-master"

Usage

New instance

use Web3Web3; $web3 = new Web3('http://localhost:8545');

Using provider

use Web3Web3; use Web3ProvidersHttpProvider; use Web3RequestManagersHttpRequestManager; $web3 = new Web3(new HttpProvider(new HttpRequestManager('http://localhost:8545'))); // timeout $web3 = new Web3(new HttpProvider(new HttpRequestManager('http://localhost:8545', 0.1)));

You can use callback to each rpc call:

$web3->clientVersion(function ($err, $version) { if ($err !== null) { // do something return; } if (isset($client)) { echo 'Client version: ' . $version; } });

Eth

use Web3Web3; $web3 = new Web3('http://localhost:8545'); $eth = $web3->eth;

Or

use Web3Eth; $eth = new Eth('http://localhost:8545');

Net

use Web3Web3; $web3 = new Web3('http://localhost:8545'); $net = $web3->net;

Or

use Web3Net; $net = new Net('http://localhost:8545');

Batch

web3

$web3->batch(true); $web3->clientVersion(); $web3->hash('0x1234'); $web3->execute(function ($err, $data) { if ($err !== null) { // do something // it may throw exception or array of exception depends on error type // connection error: throw exception // json rpc error: array of exception return; } // do something });

eth

$eth->batch(true); $eth->protocolVersion(); $eth->syncing(); $eth->provider->execute(function ($err, $data) { if ($err !== null) { // do something return; } // do something });

net

$net->batch(true); $net->version(); $net->listening(); $net->provider->execute(function ($err, $data) { if ($err !== null) { // do something return; } // do something });

personal

$personal->batch(true); $personal->listAccounts(); $personal->newAccount('123456'); $personal->provider->execute(function ($err, $data) { if ($err !== null) { // do something return; } // do something });

Contract

use Web3Contract; $contract = new Contract('http://localhost:8545', $abi); // deploy contract $contract->bytecode($bytecode)->new($params, $callback); // call contract function $contract->at($contractAddress)->call($functionName, $params, $callback); // change function state $contract->at($contractAddress)->send($functionName, $params, $callback); // estimate deploy contract gas $contract->bytecode($bytecode)->estimateGas($params, $callback); // estimate function gas $contract->at($contractAddress)->estimateGas($functionName, $params, $callback); // get constructor data $constructorData = $contract->bytecode($bytecode)->getData($params); // get function data $functionData = $contract->at($contractAddress)->getData($functionName, $params);

Assign value to outside scope(from callback scope to outside scope)

Due to callback is not like javascript callback, if we need to assign value to outside scope, we need to assign reference to callback.

$newAccount = ''; $web3->personal->newAccount('123456', function ($err, $account) use (&$newAccount) { if ($err !== null) { echo 'Error: ' . $err->getMessage(); return; } $newAccount = $account; echo 'New account: ' . $account . PHP_EOL; });

Examples

To run examples, you need to run ethereum blockchain local (testrpc).

If you are using docker as development machain, you can try ethdock to run local ethereum blockchain, just simply run docker-compose up -d testrpc and expose the 8545 port.

Develop

Local php cli installed

git clone https://github.com/chuangyeshuo/web3-plus.php.git && cd web3.php && composer install Run test script.

vendor/bin/phpunit

Docker container

git clone https://github.com/chuangyeshuo/web3-plus.php.git Copy web3.php to web3.php/docker/app directory and start container.

cp files docker/app && docker-compose up -d php Enter php container and install packages.

docker-compose exec php ash Run test script

vendor/bin/phpunit

Code of Conduct

We aim to share our knowledge and findings as we work daily to improve our product, for our community, in a safe and open space. We work as we live, as kind and considerate human beings who learn and grow from giving and receiving positive, constructive feedback. We reserve the right to delete or ban any behavior violating this base foundation of respect.

Donations

I do this because I love it, but if you want to buy me a coffee, I won't say no. :o)

Ethereum: 0x104F8FE69dF59fe4c27dd487779D49A9Ec5caCC9

License

Completely MIT Licensed. Including ALL dependencies. If you love or like it ！Please jion us!

E-mail:lucklidi@126.com，WechatID:adi1427569517

如感兴趣，请直接加入:

or you can scan it