Page d'accueil>Code source PHP>Autres catégories
Télécharger

CASHP - PHP Library for Bitcoin Cash (BCH) et SLP Token Payments

Il s'agit d'une bibliothèque PHP pour activer les paiements de token Bitcoin Cash (BCH) et SLP. Vous pouvez facilement l'utiliser avec WordPress, Laravel et d'autres cadres PHP.

Installation

Avec compositeur (recommandé): 

 composer require "ekliptor/cashp"

Installation manuelle:

  1. Téléchargez le code source et incluez cashp.php à partir du répertoire racine de cette bibliothèque.
  2. Téléchargez la source de ce package PHP QR-Code et extrayez-le sur src/phpqrcode

Exigences 

 PHP >= 7.1

Caractéristiques

  • Paiements en chaîne sans traverser une tierce partie
  • API open source configurable Backends tels que: rest.bitcoin.com ou bchd
  • Génération d'adresses 1 fois pour les paiements à l'aide de XPub (donc la clé privée de votre portefeuille n'est pas stockée sur le serveur)
  • générer des codes QR avec BCH et SLP Payment URI

Docs

Jetez un œil aux exemples de code.

Classe CASHP

__construct (CashPoptions $ options = null)

Créez la classe API principale.

  • CashpOptions $options - Options (facultatives) API (voir ci-dessous)
getrate (): échange

Renvoie l'API de taux de change.

getblockchain (): AbstractBlockChainapi

Renvoyez l'API Blockchain pour générer des adresses, vérifier les soldes, les transactions, ...

générerqrCodeForAddress (String $ filelocal, chaîne $ adresse, float $ montantbch, float $ montant = 0,0, chaîne $ tokenid = ""): bool

Générez un code QR pour un paiement.

  • string $fileLocal - un chemin sur votre système de fichiers local pour stocker le fichier de code QR. Cela devrait être accessible à partir du Web si vous souhaitez afficher le code QR aux utilisateurs. Si le fichier donné existe déjà, il ne sera pas écrasé (les codes QR sont destinés à être générés et mis en cache dans votre répertoire de température Web).
  • string $address - l'adresse (1 fois) BCH (ou SLP) créée pour ce paiement.
  • float $amountBCH - Le montant en BCH. Peut être 0 si l'utilisateur paie le montant total dans les jetons SLP.
  • float $amountToken - (facultatif) Le montant du jeton facultatif à recevoir.
  • string $tokenID - (facultatif) L'ID hexagonal du jeton SLP. Requis si $ montant> 0.

Renvoie bool - vrai sur le succès, faux sinon

CreatePaymenturi (Adresse String $, float $ montantbch, float $ mecttoken = 0.0, string $ tokenID = ""): String

Renvoyez un URI de paiement (en commençant par "BitcoinCash:" ou "Simpleledger:" Si $ montant> 0) pour l'adresse $ donnée.

  • string $address - l'adresse réceptrice BCH (ou SLP).
  • float $amountBCH - Le montant en BCH à recevoir.
  • float $amountToken - (facultatif) Le montant des jetons SLP à recevoir.
  • string $tokenID - (facultatif) L'ID hexagonal du jeton SLP. Requis si $ montant> 0.

Renvoie string

getBadgerButton (array $ btnconf, chaîne $ adresse, float $ menumbch, float $ montanttoken = 0.0, string $ tokenId = ""): chaîne

Obtenez le code HTML d'un Badgerbutton. Voir https://badger.bitcoin.com/

  • array $btnConf - Tableau associatif avec la configuration de Buttom
    • Texte (chaîne) Le texte du bouton
    • rappel (chaîne, facultatif) le nom d'une fonction de rappel présente sur la fenêtre globale à appeler après le paiement. Paramètres: String Chaintxid
    • CSSClass (String, Facultatif) Classes CSS supplémentaires pour le bouton.
    • ForceIndLedJs (bool, facultatif) par défaut false - Incluez à nouveau la bibliothèque JavaScript. Utilisez-le uniquement si vous générez du HTML pour plusieurs pages.
  • string $address - l'adresse réceptrice BCH (ou SLP).
  • float $amountBCH - Le montant en BCH à recevoir.
  • float $amountToken - (facultatif) Le montant des jetons SLP à recevoir.
  • string $tokenID - (facultatif) L'ID hexagonal du jeton SLP. Requis si $ montant> 0.

Renvoie string - le bouton html.

Isvalidbchaddress (String $ bchaddress): bool

Vérifiez si une adresse BCH est valide.

  • string $bchAddress - L'adresse au format CashAddress en commençant par 'Bitcoinash:'

Renvoie bool - vrai si l'adresse est valide, fausse autrement.

Isvalidslpaddress (String $ Slpaddress): bool

Vérifiez si une adresse SLP est valide.

  • string $slpAddress - L'adresse commençant par 'Simpleledger:'

Renvoie bool - vrai si l'adresse est valide, fausse autrement.

getReturnDdress (transaction $ tx): chaîne

Obtient l'adresse BCH de retour (appartenant à l'adresse des expéditeurs des expéditeurs) définie comme la dernière adresse des sorties de transaction.

  • Transaction $tx - La transaction de l'appel getTransaction ().

Renvoie string - l'adresse

getreturnslpaddress (transaction $ tx): chaîne

Obtient l'adresse SLP de retour (appartenant à l'adresse des expéditeurs des expéditeurs) définie comme la dernière adresse des sorties de transaction.

  • Transaction $tx - La transaction de l'appel getTransaction ().

Renvoie string - l'adresse

Classe de caisse

Un ensemble de propriétés de configuration avancées.

  • $httpAgent = null - l'implémentation HTTP utilisée pour faire des demandes HTTP. Valeurs: Basichttpagent | CurlHttpagent | WordPresshttpagent par défaut à Basichttpagent, mais vous devriez en utiliser un meilleur selon votre configuration PHP.
  • $exchangeRateExpirationMin = 60 - Combien de temps le taux de change raté doit rester en cache. Les taux actuellement ne sont pas enregistrés au-delà de l'exécution du script.
  • $httpTimeoutSec = 10 - Le délai de recours pour les demandes HTTP au backend API REST.
  • $blockchainApiImplementation = "BitcoinComRestApi" - L'implémentation du backend API REST à utiliser. Valeurs autorisées: bitcoinComRestapi | bchdprotogatewayapi | slpdbapi

Classe d'échange

Une API pour obtenir des échanges BCH à des devises fiduciaires.

getrate (String $ devise = "USD"): flotter

Obtenez le taux de change actuel pour BCH.

  • string $currency - une monnaie fiduciaire comme USD | EUR | JPY

Les retours float

Classe Blockchainapi

L'API Blockchain pour générer des adresses, vérifier les soldes, les transactions, ...

statique setlogger (callable $ loggerfn): void

Définissez une fonction Logger pour les erreurs et déboguez la sortie. Utilisez ceci pour écrire sur un fichier de journaux ou une base de données. Si aucune fonction n'est fournie, tout sera imprimé en utilisant «echo».

  • callable $loggerFn(string $subject, mixed $error, mixed $data = null) - Paramètres du php callable
Sethttpagent (AbstractThttpagent $ agent): vide

Définissez l'implémentation AA HTTP pour les demandes (Curl, API WordPress HTTP, ...)

  • AbstractHttpAgent $agent -
getConfirmationCount (String $ transactionId): int

Renvoie le nombre de confirmation pour l'ID de transaction blockchain donné.

  • string $transactionID -

Renvoie int - Le nombre de confirmations ou -1 si le $ TransactionID n'existe pas.

CreateEnewAddress (String $ xpub, int $ adresse, string $ hdpathformat = '0 /% d') :? bchaddress

Crée une nouvelle adresse du Xpub.

  • string $xPub - la clé publique étendue. Appelé «Master Public Key» en espèces électroniques.
  • int $addressCount - Le numéro de l'adresse suivante pour générer une adresse unique. Habituellement, cela devrait être un entier incrémenté.
  • string $hdPathFormat - (facultatif) Le chemin HD à utiliser pour créer des enfants d'adresse.

Renvoie BchAddress - l'adresse ou null en panne

getTokenInfo (String $ tokenid) :? Slptoken

Obtenez des informations générales (à l'échelle du réseau) sur un jeton SLP.

  • string $tokenID -

Renvoie SlpToken - le jeton ou null en échec

getAddressBalance (adresse de chaîne $): flottante

Renvoyez le solde BCH de l'adresse donnée (y compris les transactions non confirmées).

  • string $address - l'adresse BCH au format CashAddress.

Renvoie float - le solde ou -1 si l'adresse n'existe pas.

getAddressTokenBalance (adresse de chaîne $, chaîne $ tokenid): float

Renvoyez le solde du jeton de l'adresse SLP donnée (y compris les transactions non confirmées).

  • string $address -
  • string $tokenID -

Renvoie float - le solde ou -1 si l'adresse n'existe pas.

getAddressDetails (adresse de chaîne $) :? bchaddress

Renvoyez l'adresse BCH avec toutes ses propriétés telles que l'équilibre, les txides, ...

  • string $address - l'adresse BCH au format CashAddress.

Renvoie BchAddress - l'adresse ou null en panne

GetSlpaddressDetails (Adresse String $, String $ tokenID) :? SlptokenDdress

Retour les détails du jeton SLP d'une adresse donnée incluent l'équilibre, les txids, ...

  • string $address -
  • string $tokenID -

Renvoie SlpTokenAddress - le jeton ou null en échec

getTransaction (String $ TransactionID):? Transaction

Renvoie une transaction avec toutes les entrées et sorties, y compris les données SLP.

  • string $transactionID -

Renvoie Transaction - la transaction ou null en panne

Essai

Pour exécuter des tests unitaires, tapez la commande suivante dans le répertoire root du projet (nécessite un phpunit, installé automatiquement avec le compositeur):

./vendor/bin/phpunit --bootstrap vendor/autoload.php tests

Faire

  • Ajouter une vérification d'adresse SLP
  • Implémentez plus de fonctions de l'API REST
  • Implémentez la création d'adresses à l'aide de XPub avec SLPDB (après son prise en charge)

Contact

Gazouillement

Plugin WordPress

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout