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

ActiveLibrary[API Development](/categories/api)

benant/web3.php
===============

Ethereum web3 interface.

0.1.4(8y ago)0334MITPHPPHP ^7.1

Since Mar 18Pushed 4y ago1 watchersCompare

[ Source](https://github.com/benant/web3.php)[ Packagist](https://packagist.org/packages/benant/web3.php)[ RSS](/packages/benant-web3php/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (2)Dependencies (4)Versions (8)Used By (0)

web3.php
========

[](#web3php)

[![Build Status](https://camo.githubusercontent.com/8ab387b42477a92f2eb5be697d2709ec2bc40024d9664e61bb79e3312e0e0124/68747470733a2f2f7472617669732d63692e6f72672f62656e616e742f776562332e7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/benant/web3.php)[![Licensed under the MIT License](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)](https://github.com/benant/web3.php/blob/master/LICENSE)

This repository has forked version 0.1.4 of sc0vu/web3.php. The latest source for web3.php is in sc0vu/web3.php. I referenced . I created this repository to distinguish between synchronous and asynchronous operations.

todo
====

[](#todo)

- Checking synchronous processing during batch operation
- Checking error exception handling in synchronous processing.

Install
=======

[](#install)

Set minimum stability to dev

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

```

Then

```
composer require benant/web3.php 0.1.4-b.0.2

```

Or you can add this line in composer.json

```
"benant/web3.php": "0.1.4-b.0.2"

```

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

// sync.
$web3 = new Web3(new HttpProvider(new HttpRequestManager('http://localhost:8545', 0.1, false)));
```

### You can use callback to each rpc call:

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

\[async.\]

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

\[sync.\]

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

### 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/benant/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/benant/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/benant/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.

License
=======

[](#license)

MIT

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 93.4% 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 ~20 days

Total

7

Last Release

2906d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2987235?v=4)[Benant](/maintainers/benant)[@benant](https://github.com/benant)

---

Top Contributors

[![sc0Vu](https://avatars.githubusercontent.com/u/10494397?v=4)](https://github.com/sc0Vu "sc0Vu (396 commits)")[![benant](https://avatars.githubusercontent.com/u/2987235?v=4)](https://github.com/benant "benant (12 commits)")[![1099511627776](https://avatars.githubusercontent.com/u/2117414?v=4)](https://github.com/1099511627776 "1099511627776 (4 commits)")[![sinabs](https://avatars.githubusercontent.com/u/1351257?v=4)](https://github.com/sinabs "sinabs (3 commits)")[![Arul-](https://avatars.githubusercontent.com/u/2255137?v=4)](https://github.com/Arul- "Arul- (2 commits)")[![refear99](https://avatars.githubusercontent.com/u/7454701?v=4)](https://github.com/refear99 "refear99 (1 commits)")[![sciku1](https://avatars.githubusercontent.com/u/11371543?v=4)](https://github.com/sciku1 "sciku1 (1 commits)")[![sunshuzhou](https://avatars.githubusercontent.com/u/2659011?v=4)](https://github.com/sunshuzhou "sunshuzhou (1 commits)")[![a10000005588](https://avatars.githubusercontent.com/u/12505827?v=4)](https://github.com/a10000005588 "a10000005588 (1 commits)")[![amateescu](https://avatars.githubusercontent.com/u/246655?v=4)](https://github.com/amateescu "amateescu (1 commits)")[![lsmelan](https://avatars.githubusercontent.com/u/4654979?v=4)](https://github.com/lsmelan "lsmelan (1 commits)")[![pash7ka](https://avatars.githubusercontent.com/u/2335215?v=4)](https://github.com/pash7ka "pash7ka (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/benant-web3php/health.svg)

```
[![Health](https://phpackages.com/badges/benant-web3php/health.svg)](https://phpackages.com/packages/benant-web3php)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

751291.4k40](/packages/civicrm-civicrm-core)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M560](/packages/shopware-core)[soneso/stellar-php-sdk

Stellar PHP SDK for the Stellar Network

4154.3k4](/packages/soneso-stellar-php-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)[aimeos/prisma

A powerful PHP package for integrating media related Large Language Models (LLMs) into your applications

1943.1k5](/packages/aimeos-prisma)

PHPackages © 2026

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