pauljulianheise/cryptocurrency-unit-converter

A library for performing easy and fast conversion between various cryptocurrency units.

1.0.2 2022-07-29 15:49 UTC

Requires

• php: >=8.0.0
• ext-bcmath: *

Requires (Dev)

• phpunit/phpunit: 9.5.x-dev

MIT

• Paul Julian Heise

README

A library for performing easy and fast conversion between various cryptocurrency units.

Installation:
requires PHP 8.0 and the bcmath extension

composer require pauljulianheise/cryptocurrency-unit-converter  

Supported Blockchains & Cryptocurrencies:

• Ethereum (ETH)
• Binance Smart Chain (BNB)
• Solana (SOL)
• Cardano (ADA)
• Polygon (MATIC)
• Tron (TRX)

Usage:

The convert function accepts an amount, the unit of the amount and the unit you want to convert to.

public function convert(string $amount, string $from, string $to): string

use PaulJulianHeise\CryptoCurrency\Blockchains\Ethereum;  
use PaulJulianHeise\CryptoCurrency\Blockchains\Binance;  
use PaulJulianHeise\CryptoCurrency\Blockchains\Solana;  
use PaulJulianHeise\CryptoCurrency\Blockchains\Cardano;  
use PaulJulianHeise\CryptoCurrency\Blockchains\Polygon;  
use PaulJulianHeise\CryptoCurrency\Blockchains\Tron;  

$converter = new Converter();

// CONSTANTS: WEI, KWEI, MWEI, GWEI, SZABO, FINNEY, ETHER, KETHER, METHER, GETHER, TETHER  
$convertedValue = $converter->ethereum()->convert("1", Ethereum::ETHER, Ethereum::WEI);  
  
  
// CONSTANTS: WEI, KWEI, MWEI, GWEI, SZABO, FINNEY, BNB, KBNB, MBNB, GBNB, TBNB  
$convertedValue = $converter->binance()->convert("1", Binance::BNB, Binance::WEI);  


// CONSTANTS: SOL, LAMPORT 
$convertedValue = $converter->solana()->convert("1", Solana::SOL, Solana::LAMPORT);  


// CONSTANTS: ADA, LOVELACE  
$convertedValue = $converter->cardano()->convert("1", Cardano::ADA, Cardano::LOVELACE);  


// CONSTANTS: WEI, KWEI, MWEI, GWEI, SZABO, FINNEY, MATIC, KMATIC, MMATIC, GMATIC, TMATIC
$convertedValue = $converter->polygon()->convert("1", Polygon::MATIC, Polygon::WEI); 


// CONSTANTS: TRX, SUN
$convertedValue = $converter->tron()->convert("1", Tron::TRX, Tron::SUN); 

The value to be converted should only contain a single "." as a delimiter and no comma:

use PaulJulianHeise\CryptoCurrency\Ethereum  
use PaulJulianHeise\CryptoCurrency\Binance;  

$converter = new Converter(); 
// will throw an exception
$convertedValue = $converter->ethereum()->convert("1,4", Ethereum::ETHER, Ethereum::WEI);