PHPackages                             xiaohuasheng0x1/web3-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. xiaohuasheng0x1/web3-php

ActiveLibrary[API Development](/categories/api)

xiaohuasheng0x1/web3-php
========================

Ethereum web3 interface.

1.0.0(2y ago)0252MITPHPPHP >=7.2

Since Aug 27Pushed 2y ago1 watchersCompare

[ Source](https://github.com/xiaohuasheng0x1/web3-php)[ Packagist](https://packagist.org/packages/xiaohuasheng0x1/web3-php)[ RSS](/packages/xiaohuasheng0x1-web3-php/feed)WikiDiscussions 1.0.0 Synced 1mo ago

READMEChangelogDependencies (4)Versions (2)Used By (2)

web3-php
========

[](#web3-php)

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

Install
=======

[](#install)

Set minimum stability to dev

```
"minimum-stability": "dev"

```

Then

```
composer require xiaohuasheng0x1/web3.php dev-master

```

Or you can add this line in composer.json

```
"xiaohuasheng0x1/web3.php": "dev-master"

```

Usage
=====

[](#usage)

### New instance

[](#new-instance)

```
use Web3\Web3;

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

### Using provider

[](#using-provider)

```
use Web3\Web3;
use Web3\Providers\HttpProvider;
use Web3\RequestManagers\HttpRequestManager;

$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:

[](#you-can-use-callback-to-each-rpc-call)

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

### Eth

[](#eth)

```
use Web3\Web3;

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

Or

```
use Web3\Eth;

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

### Net

[](#net)

```
use Web3\Web3;

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

Or

```
use Web3\Net;

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

### Batch

[](#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

[](#contract)

```
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);
```

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

[](#assign-value-to-outside-scopefrom-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
========

[](#examples)

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

If you are using docker as development machain, you can try [ethdock](https://github.com/sc0vu/ethdock) to run local ethereum blockchain, just simply run `docker-compose up -d testrpc` and expose the `8545` port.

Develop
=======

[](#develop)

### Local php cli installed

[](#local-php-cli-installed)

1. Clone the repo and install packages.

```
git clone https://github.com/web3p/web3.php.git && cd web3.php && composer install

```

2. Run test script.

```
vendor/bin/phpunit

```

### Docker container

[](#docker-container)

1. Clone the repo and run docker container.

```
git clone https://github.com/web3p/web3.php.git

```

2. Copy web3.php to web3.php/docker/app directory and start container.

```
cp files docker/app && docker-compose up -d php ganache

```

3. Enter php container and install packages.

```
docker-compose exec php ash

```

4. Change testHost in `TestCase.php`

```
/**
 * testHost
 *
 * @var string
 */
protected $testHost = 'http://ganache:8545';

```

5. Run test script

```
vendor/bin/phpunit

```

###### Install packages

[](#install-packages)

Enter container first

```
docker-compose exec php ash

```

1. gmp

```
apk add gmp-dev
docker-php-ext-install gmp

```

2. bcmath

```
docker-php-ext-install bcmath

```

###### Remove extension

[](#remove-extension)

Move the extension config from `/usr/local/etc/php/conf.d/`

```
mv /usr/local/etc/php/conf.d/extension-config-name to/directory

```

API
===

[](#api)

Todo.

Contribution
============

[](#contribution)

Thank you to all the people who already contributed to web3.php! [![](https://camo.githubusercontent.com/defe6a1fe907946b9490f595267a37409cf88f72f1eea25da12408d57d708351/68747470733a2f2f636f6e747269622e726f636b732f696d6167653f7265706f3d77656233702f776562332e706870)](https://github.com/web3p/web3.php/graphs/contributors)

License
=======

[](#license)

MIT

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

987d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4646175128c98659d5d3409a25c6122e7752dca1c5dcc99b3c00692d15434300?d=identicon)[xiaohuasheng0x1](/maintainers/xiaohuasheng0x1)

---

Top Contributors

[![xiaohuasheng0x1](https://avatars.githubusercontent.com/u/126474581?v=4)](https://github.com/xiaohuasheng0x1 "xiaohuasheng0x1 (4 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/xiaohuasheng0x1-web3-php/health.svg)

```
[![Health](https://phpackages.com/badges/xiaohuasheng0x1-web3-php/health.svg)](https://phpackages.com/packages/xiaohuasheng0x1-web3-php)
```

###  Alternatives

[wheelpros/fitment-platform-api

Magento 2 (Open Source)

12.1k1.2k](/packages/wheelpros-fitment-platform-api)[packbackbooks/lti-1p3-tool

A library used for building IMS-certified LTI 1.3 tool providers in PHP.

51438.3k2](/packages/packbackbooks-lti-1p3-tool)[yoti/yoti-php-sdk

Yoti SDK for quickly integrating your PHP backend with Yoti

27539.9k1](/packages/yoti-yoti-php-sdk)[hoels/app-store-server-library-php

The PHP server library for the App Store Server API and App Store Server Notifications.

44162.2k](/packages/hoels-app-store-server-library-php)[sc0vu/web3.php

Ethereum web3 interface.

96165.3k17](/packages/sc0vu-web3php)[soneso/stellar-php-sdk

Stellar PHP SDK for the Stellar Network

4048.2k4](/packages/soneso-stellar-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)