Inicio>código fuente PHP>Otras categorias
Descargar

CashP - Biblioteca PHP para Bitcoin Cash (BCH) y Pagos de token SLP

Esta es una biblioteca PHP para habilitar Bitcoin Cash (BCH) y pagos de token SLP. Puede usar esto fácilmente con WordPress, Laravel y otros marcos PHP.

Instalación

Con compositor (recomendado): 

 composer require "ekliptor/cashp"

Instalación manual:

  1. Descargue el código fuente e incluya cashp.php desde el directorio raíz de esta biblioteca.
  2. Descargue la fuente de este paquete PHP QR-Code y extraiga a src/phpqrcode

Requisitos 

 PHP >= 7.1

Características

  • Pagos en la cadena sin pasar por un tercero
  • Backends de API de código abierto configurables como: REST.BITCOIN.com o BCHD
  • 1 tiempo generación de direcciones para pagos utilizando XPUB (por lo que la clave privada de su billetera no se almacena en el servidor)
  • Genere códigos QR con URI de pago BCH y SLP

Documento

Eche un vistazo a los ejemplos de código.

Clase Cashp

__construct (CashPoptions $ options = null)

Crea la clase API principal.

  • CashpOptions $options - Opciones de API (opcionales) (ver más abajo)
getRate (): intercambiar

Devolver la API del tipo de cambio.

GetBlockChain (): AbstractBlockChainapi

Devuelva la API blockchain para generar direcciones, verificar saldos, transacciones, ...

generarqrCodeForAddress (cadena $ filelocal, cadena $ dirección, float $ montionbch, float $ montayToken = 0.0, cadena $ tokenid = ""): bool

Genere un código QR para un pago.

  • string $fileLocal : una ruta en su sistema de archivos local para almacenar el archivo de código QR. Esto debe ser accesible desde la web si desea mostrar el código QR a los usuarios. Si el archivo dado ya existe, no se sobrescribirá (los códigos QR deben generarse y almacenarse en caché en su directorio de temperatura web).
  • string $address : la dirección (1 vez) BCH (o SLP) creada para este pago.
  • float $amountBCH - La cantidad en BCH. Puede ser 0 si el usuario paga el monto total en los tokens SLP.
  • float $amountToken - (Opcional) La cantidad del token opcional que se recibirá.
  • string $tokenID - (opcional) La ID hexadecimal del token SLP. Requerido si $ montayToken> 0.

Devuelve bool - Verdadero sobre el éxito, falso de lo contrario

CreatePayMentUri (String $ Dirección, Float $ MidingBCH, Float $ montayToken = 0.0, cadena $ tokenid = ""): cadena

Devuelva un URI de pago (comenzando con "Bitcoincash:" o "SimpleLedger:" Si $ montayToken> 0) para la dirección $ dada.

  • string $address : la dirección BCH (o SLP) receptor.
  • float $amountBCH - El monto en BCH para recibir.
  • float $amountToken - (Opcional) La cantidad de tokens SLP para recibir.
  • string $tokenID - (opcional) La ID hexadecimal del token SLP. Requerido si $ montayToken> 0.

Devuelve string

getBadgerButton (array $ btnconf, cadena $ dirección, float $ montionbch, float $ montayToken = 0.0, cadena $ tokenid = ""): cadena

Obtenga el código HTML de un BadgerButton. Ver https://badger.bitcoin.com/

  • array $btnConf - matriz asociativa con configuración de Buttom
    • texto (cadena) El texto del botón
    • devolución de llamada (cadena, opcional) El nombre de una función de devolución de llamada presente en la ventana global que se llamará después del pago. Parámetros: String Chaintxid
    • CSSClass (String, Opcional) Clases CSS adicionales para el botón.
    • ForceIndludeJS (bool, opcional) predeterminado Falso - Incluya la biblioteca JavaScript nuevamente. Solo use esto si está generando HTML para varias páginas.
  • string $address : la dirección BCH (o SLP) receptor.
  • float $amountBCH - El monto en BCH para recibir.
  • float $amountToken - (Opcional) La cantidad de tokens SLP para recibir.
  • string $tokenID - (opcional) La ID hexadecimal del token SLP. Requerido si $ montayToken> 0.

Devuelve string - el botón HTML.

isValidbChaddress (cadena $ bchaddress): bool

Verifique si una dirección BCH es válida.

  • string $bchAddress : la dirección en formato de casillero que comienza con 'bitcoincash:'

Devuelve bool : verdadero si la dirección es válida, falsa de lo contrario.

isValidslpaddress (cadena $ slpaddress): bool

Verifique si una dirección SLP es válida.

  • string $slpAddress : la dirección que comienza con 'simpleledger:'

Devuelve bool : verdadero si la dirección es válida, falsa de lo contrario.

getReturnaddress (transacción $ tx): cadena

Obtiene la dirección BCH de devolución (perteneciente a la dirección del remitente del remitente) definida como la última dirección en las salidas de transacciones.

  • Transaction $tx : la transacción de la llamada getTransaction ().

Devuelve string : la dirección

getReturnSlpaddress (transacción $ tx): cadena

Obtiene la dirección de retorno SLP (perteneciente a la dirección del remitente del remitente) definida como la última dirección en las salidas de transacciones.

  • Transaction $tx : la transacción de la llamada getTransaction ().

Devuelve string : la dirección

Clase de CashPoptions

Un conjunto de propiedades de configuración avanzadas.

  • $httpAgent = null : la implementación HTTP utilizada para realizar solicitudes HTTP. Valores: BASICHTTPAGENT | Curlhttpagent | WordPresshttpagent predeterminado a BasichttTpagent, pero debe usar uno mejor de acuerdo con su configuración de PHP.
  • $exchangeRateExpirationMin = 60 - cuánto tiempo se mantendrá en caché el tipo de cambio rastreo. Actualmente, las tasas no se guardan más allá de la ejecución del script.
  • $httpTimeoutSec = 10 : el tiempo de espera para las solicitudes HTTP al backend de la API REST.
  • $blockchainApiImplementation = "BitcoinComRestApi" : la implementación de backend de la API REST para usar. Valores permitidos: bitcoincomrestapi | bchdprotogatewayapi | slpdbapi

Intercambiar clase

Una API para obtener tasas de intercambio de BCH a monedas fiduciarias.

getRate (cadena $ moneda = "usd"): flotante

Obtenga el tipo de cambio actual para BCH.

  • string $currency : una moneda fiduciaria como USD | EUR | JPY

Devuelve float

Clase blockchainapi

La API blockchain para generar direcciones, verificar saldos, transacciones, ...

staticLogger (llamable $ loggerfn): void

Establezca una función de registrador para errores y salida de depuración. Use esto para escribir en un archivo de registro o base de datos. Si no se proporciona ninguna función, todo se imprimirá usando 'Echo'.

  • callable $loggerFn(string $subject, mixed $error, mixed $data = null) - parámetros del PHP llamado
sethttpagent (abstractthttpagent $ agente): nulo

Establecer la implementación de AA HTTP para solicitudes (Curl, WordPress HTTP API, ...)

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

Devuelva el número de confirmación para la ID de transacción blockchain dada.

  • string $transactionID -

Devuelve int - el número de confirmaciones o -1 si el $ transaccionId no existe.

CreateNewaddress (String $ XPUB, int $ DirectionCount, String $ hdpathformat = '0/%d') :? bchaddress

Crea una nueva dirección del XPUB.

  • string $xPub : la clave pública extendida. Llamado 'Key Public Master' en Cash Electron.
  • int $addressCount : el número de la siguiente dirección para generar una dirección única. Por lo general, esto debería ser un entero incrementoso.
  • string $hdPathFormat - (Opcional) La ruta HD se utilizará para crear niños de dirección.

Devuelve BchAddress : la dirección o null en la falla

getTokeninfo (cadena $ tokenid) :? slpToken

Obtenga información general (en toda la red) sobre un token SLP.

  • string $tokenID -

Devuelve SlpToken : el token o null sobre la falla

getAddressBalance (String $ Dirección): Float

Devuelva el saldo BCH de la dirección dada (incluidas las transacciones no confirmadas).

  • string $address : la dirección BCH en formato Cashaddress.

Devuelve float : el saldo o -1 si la dirección no existe.

getAddressTokenBalance (String $ Dirección, cadena $ Tokenid): Float

Devuelva el saldo del token de la dirección SLP dada (incluidas las transacciones no confirmadas).

  • string $address -
  • string $tokenID -

Devuelve float : el saldo o -1 si la dirección no existe.

getAddressDetails (cadena $ dirección) :? bchaddress

Devuelva la dirección BCH con todas sus propiedades, como Balance, TXIDS, ...

  • string $address : la dirección BCH en formato Cashaddress.

Devuelve BchAddress : la dirección o null en la falla

getSlPaddressDetails (String $ Dirección, cadena $ Tokenid):?

Devuelve los detalles del token SLP de una dirección dada incluyen Balance, TXIDS, ...

  • string $address -
  • string $tokenID -

Devuelve SlpTokenAddress : el token o null sobre la falla

getTransaction (string $ transaccionId) :? Transaction

Devuelve una transacción con todas las entradas y salidas, incluidos los datos de SLP.

  • string $transactionID -

Devuelve Transaction : la transacción o null en la falla

Pruebas

Para ejecutar pruebas unitarias, escriba el siguiente comando en el directorio raíz del proyecto (requiere phpunit, instalado automáticamente con el compositor):

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

Hacer

  • Agregar verificación de dirección SLP
  • Implementar más funciones de la API REST
  • Implementar la creación de direcciones utilizando XPUB con SLPDB (después de que sea compatible)

Contacto

Gorjeo

Complemento de WordPress

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo