PHPackages                             chuangyeshuo/web3-plus.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. chuangyeshuo/web3-plus.php

ActiveLibrary[API Development](/categories/api)

chuangyeshuo/web3-plus.php
==========================

Ethereum web3 interface.

1.1(7y ago)4292MITPHP

Since Aug 7Pushed 7y ago1 watchersCompare

[ Source](https://github.com/chuangyeshuo/web3-plus.php)[ Packagist](https://packagist.org/packages/chuangyeshuo/web3-plus.php)[ RSS](/packages/chuangyeshuo-web3-plusphp/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (4)Versions (4)Used By (0)

web3-plus.php
=============

[](#web3-plusphp)

[![Licensed under the MIT License](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)

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

Install
=======

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

[](#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($client)) {
        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/chuangyeshuo/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/chuangyeshuo/web3-plus.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/chuangyeshuo/web3-plus.php.git

```

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

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

```

3. Enter php container and install packages.

```
docker-compose exec php ash

```

4. Run test script

```
vendor/bin/phpunit

```

Code of Conduct
===============

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

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

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

```

[![Image text](https://github.com/fomo3d-wiki/books/raw/master/images/weixinGZ.jpg)](https://github.com/fomo3d-wiki/books/blob/master/images/weixinGZ.jpg)

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity64

Established project with proven stability

 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

3

Last Release

2838d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c8bfcd95d83b64c291d768124e0f9d04a0f2867f12e6f232edec499f10811782?d=identicon)[chuangyeshuo](/maintainers/chuangyeshuo)

---

Top Contributors

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

---

Tags

blockchainethphpweb3web3php

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/chuangyeshuo-web3-plusphp/health.svg)

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

###  Alternatives

[wheelpros/fitment-platform-api

Magento 2 (Open Source)

12.1k1.2k](/packages/wheelpros-fitment-platform-api)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[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)[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)