furqansiddiqui/erc20-php

Interact with any ERC20 standard/backward-compatible Ethereum token

Maintainers

Details

github.com/furqansiddiqui/erc20-php

Source

Issues

Installs: 45 672

Dependents: 4

Suggesters: 0

Security: 0

Stars: 162

Watchers: 21

Forks: 100

Open Issues: 1

0.3.0 2023-02-07 01:29 UTC

Requires

MIT 78ac0814aaee7209ca27a743c76aa0a5548d522a

ethereumethgethethereum-goerc20infuraerc223infura.io

This package is auto-updated.

Last update: 2024-04-07 04:00:20 UTC

README

Interact with any ERC20 standard Ethereum token

This package is ultimate response to historic issue of no native API being available to PHP developers to interact with ERC20 tokens (i.e. web3js contracts API).

This package relies on furqansiddiqui/ethereum-php package to perform all ABI encoding and decoding, as well as communication with Ethereum node using RPC/API, resulting in pure simple and easy to use API for developers to perform all ERC20 standard operations.

Ethereum Node Status
Geth / Ethereum-Go RPC ✔️
Infura.IO ✔️

Demo

  • Testing interaction with Thether USD / USDT ERC20 smart contract:
use FurqanSiddiqui\Ethereum\RPC\Infura;
use FurqanSiddiqui\Ethereum\ERC20\ERC20;

$infura = new Infura("PROJECT-ID", "PROJECT-SECRET");
$infura->ignoreSSL(); // In case Infura.IO SSL errors (or provide "caRootFile:" to constructor above)

$erc20 = new ERC20($infura);
$usdt = $erc20->deployedAt("0xdac17f958d2ee523a2206206994597c13d831ec7");
var_dump($usdt->name());
var_dump($usdt->symbol());
var_dump($usdt->decimals());
var_dump($usdt->totalSupply());
$balance = $usdt->balanceOf($eth->getAccount("ETHEREUM-ADDRESS"));
var_dump($balance);
var_dump($usdt->getScaledValue($balance));

Result:

string(9) "TetherUSD"
string(4) "USDT"
int(6)
string(18) "32284517903064882"
string(11) "53150417979"
string(12) "53150.417979"

Custom ABI

  • Standard/base ERC20 ABI is included in package.
  • To included extended/custom ERC20 ABI (depending on your requirments), use one of the following methods:
    • Extend BaseERC20Contract class to define custom ABI functions and events.
    • Decode your custom ABI JSON file and provide it to constructor:
use \FurqanSiddiqui\Ethereum\Contracts\Contract;

$customABI  =   Contract::fromArray(json_decode(file_get_contents("YOUR-CUSTOM-ABI.json"), true), true);
$erc20 = new ERC20(abi: $customABI);

Scaled Values

Use getScaledValue and fromScaledValue to convert amounts from/to uint256.

Prerequisites

Installation

composer require furqansiddiqui/erc20-php

Changelog

  • 0.3.0: This library alongside several others such as ethereum-php have been modernised and requires PHP ^8.1.