A php interface for interacting with the Ethereum blockchain and ecosystem. Native ABI parsing and smart contract interactions.
MIT License
A php interface for interacting with the Ethereum blockchain and ecosystem.
Set minimum stability to dev
"minimum-stability": "dev"
Then
composer require web3p/web3.php dev-master
Or you can add this line in composer.json
"web3p/web3.php": "dev-master"
use Web3\Web3;
$web3 = new Web3('http://localhost:8545');
use Web3\Web3;
use Web3\Providers\HttpProvider;
$web3 = new Web3(new HttpProvider('http://localhost:8545'));
// timeout
$web3 = new Web3(new HttpProvider('http://localhost:8545', 0.1));
$web3->clientVersion(function ($err, $version) {
if ($err !== null) {
// do something
return;
}
if (isset($version)) {
echo 'Client version: ' . $version;
}
});
use Web3\Web3;
use Web3\Providers\HttpAsyncProvider;
$web3 = new Web3(new HttpAsyncProvider('http://localhost:8545'));
// timeout
$web3 = new Web3(new HttpAsyncProvider('http://localhost:8545', 0.1));
// await
$promise = $web3->clientVersion(function ($err, $version) {
// do somthing
});
Async\await($promise);
use Web3\Web3;
use Web3\Providers\WsProvider;
$web3 = new Web3(new WsProvider('ws://localhost:8545'));
// timeout
$web3 = new Web3(new WsProvider('ws://localhost:8545', 0.1));
// await
$promise = $web3->clientVersion(function ($err, $version) {
// do somthing
});
Async\await($promise);
// close connection
$web3->provider->close();
use Web3\Web3;
$web3 = new Web3('http://localhost:8545');
$eth = $web3->eth;
Or
use Web3\Eth;
$eth = new Eth('http://localhost:8545');
use Web3\Web3;
$web3 = new Web3('http://localhost:8545');
$net = $web3->net;
Or
use Web3\Net;
$net = new Net('http://localhost:8545');
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
});
use Web3\Contract;
$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);
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;
});
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.
git clone https://github.com/web3p/web3.php.git && cd web3.php && composer install
vendor/bin/phpunit
git clone https://github.com/web3p/web3.php.git
cp files docker/app && docker-compose up -d php ganache
docker-compose exec php ash
TestCase.php
/**
* testHost
*
* @var string
*/
protected $testHost = 'http://ganache:8545';
vendor/bin/phpunit
Enter container first
docker-compose exec php ash
apk add gmp-dev
docker-php-ext-install gmp
docker-php-ext-install bcmath
Move the extension config from /usr/local/etc/php/conf.d/
mv /usr/local/etc/php/conf.d/extension-config-name to/directory
Todo.
Thank you to all the people who already contributed to web3.php!
MIT