PHPackages                             kodmanyagha/web3php - 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. kodmanyagha/web3php

ActiveLibrary

kodmanyagha/web3php
===================

Ethereum web3 interface.

1.0.25(3y ago)086MITPHPPHP ^7.2|^8.0|^8.1

Since Nov 11Pushed 3y ago1 watchersCompare

[ Source](https://github.com/kodmanyagha/web3php)[ Packagist](https://packagist.org/packages/kodmanyagha/web3php)[ RSS](/packages/kodmanyagha-web3php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (8)Versions (27)Used By (0)

web3.php
========

[](#web3php)

[![PHP](https://github.com/kodmanyagha/web3php/actions/workflows/php.yml/badge.svg)](https://github.com/web3p/web3.php/actions/workflows/php.yml)[![Build Status](https://camo.githubusercontent.com/18151cf6123367af48014edccdab56308c17c89d4ec2f909c8b4c239cfbc7aa6/68747470733a2f2f7472617669732d63692e6f72672f6b6f646d616e79616768612f776562337068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/kodmanyagha/web3php)[![codecov](https://camo.githubusercontent.com/95ab3f421d3095ee8f4287e16298f911ff0651f54f5554c19c955dbe72c363ec/68747470733a2f2f636f6465636f762e696f2f67682f6b6f646d616e79616768612f776562337068702f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/web3p/web3.php)[![Join the chat at https://gitter.im/web3-php/web3.php](https://camo.githubusercontent.com/4b8417cc6318d32b8268f39a1dc8c8f9099e1b7ff1258aa4ed44ba1459056553/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6769747465722d6a6f696e253230636861742d627269676874677265656e2e737667)](https://gitter.im/kodmanyagha/web3php)[![Licensed under the MIT License](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)](https://github.com/kodmanyagha/web3php/blob/master/LICENSE)

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

Install
=======

[](#install)

Set minimum stability to dev

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

```

Then

```
composer require kodmanyagha/web3php dev-master

```

Or you can add this line in composer.json

```
"kodmanyagha/web3php": "dev-master"

```

Usage
=====

[](#usage)

### New instance

[](#new-instance)

```
use Kdm\Web3;

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

### Using provider

[](#using-provider)

```
use Kdm\Web3;
use Kdm\Providers\HttpProvider;
use Kdm\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 Kdm\Web3;

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

Or

```
use Kdm\Eth;

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

### Net

[](#net)

```
use Kdm\Web3;

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

Or

```
use Kdm\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 Kdm\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 web3php to web3php/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

```

3openssl

```
docker-php-ext-install openssl

```

###### 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

```

License
=======

[](#license)

MIT

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity65

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 ~2 days

Recently: every ~15 days

Total

26

Last Release

1223d ago

### Community

Maintainers

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

---

Top Contributors

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

---

Tags

ethereumphpweb3web3php

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[laravel/socialite

Laravel wrapper around OAuth 1 & OAuth 2 libraries.

5.7k96.9M674](/packages/laravel-socialite)[fenguoz/bsc-php

Support Binance's BNB and BEP20, which include functions such as address creation, balance query, transaction transfer, query the latest blockchain, query information based on the blockchain, and query information based on the transaction hash

4720.9k](/packages/fenguoz-bsc-php)[madwizard/webauthn

Web Authentication API server for PHP

6194.9k1](/packages/madwizard-webauthn)[concrete5/core

Concrete core subtree split

19159.3k48](/packages/concrete5-core)[didww/didww-api-3-php-sdk

PHP SDK for DIDWW API 3

1218.2k](/packages/didww-didww-api-3-php-sdk)

PHPackages © 2026

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