cashp

CASTP - ห้องสมุด PHP สำหรับ Bitcoin Cash (BCH) และ SLP Token Payments

นี่คือห้องสมุด PHP เพื่อเปิดใช้งาน Bitcoin Cash (BCH) และ SLP Token Payments คุณสามารถใช้สิ่งนี้ได้อย่างง่ายดายด้วย WordPress, Laravel และเฟรมเวิร์ก PHP อื่น ๆ

การติดตั้ง

กับนักแต่งเพลง (แนะนำ):

 composer require "ekliptor/cashp"

การติดตั้งด้วยตนเอง:

1. ดาวน์โหลดซอร์สโค้ดและรวม cashp.php จากไดเรกทอรีรูทของไลบรารีนี้
2. ดาวน์โหลดแหล่งที่มาของแพ็คเกจ PHP QR-Code และแยกไปยัง src/phpqrcode

ความต้องการ

 PHP >= 7.1

คุณสมบัติ

• การชำระเงินบนห่วงโซ่โดยไม่ต้องผ่านบุคคลที่สาม
• แบ็กเอนด์ API โอเพ่นซอร์สที่กำหนดค่าได้เช่น: rest.bitcoin.com หรือ BCHD
• การสร้างที่อยู่ 1 ครั้งสำหรับการชำระเงินโดยใช้ XPUB (ดังนั้นคีย์ส่วนตัวของกระเป๋าเงินของคุณจะไม่ถูกเก็บไว้บนเซิร์ฟเวอร์)
• สร้างรหัส QR ด้วยการชำระเงิน BCH และ SLP URIS

เอกสาร

ดูตัวอย่างรหัส

ชั้นเรียน CASTP

__Construct (CASHPOPTIONS $ OPTIOMS = NULL)

สร้างคลาส API หลัก

• CashpOptions $options (ไม่บังคับ) API (ดูด้านล่าง)

getRate (): แลกเปลี่ยน

ส่งคืน API อัตราแลกเปลี่ยน

getBlockchain (): AbstractBlockchainapi

ส่งคืน blockchain API เพื่อสร้างที่อยู่ตรวจสอบยอดคงเหลือการทำธุรกรรม ...

generateQrCodeForAddress (สตริง $ filelocal, สตริง $ ที่อยู่, ลอย $ tumberBch, ลอย $ umentToken = 0.0, สตริง $ tokenid = ""): bool

สร้างรหัส QR สำหรับการชำระเงิน

• string $fileLocal - พา ธ ในระบบไฟล์โลคัลของคุณเพื่อจัดเก็บไฟล์รหัส QR สิ่งนี้ควรเข้าถึงได้จากเว็บหากคุณต้องการแสดงรหัส QR ให้กับผู้ใช้ หากไฟล์ที่กำหนดมีอยู่แล้วมันจะไม่ถูกเขียนทับ (รหัส QR นั้นมีไว้เพื่อสร้างและแคชในไดเรกทอรีเว็บของคุณ)
• string $address - ที่อยู่ (1 ครั้ง) BCH (หรือ SLP) ที่สร้างขึ้นสำหรับการชำระเงินนี้
• float $amountBCH - จำนวนเงินใน BCH สามารถเป็น 0 ถ้าผู้ใช้จ่ายเต็มจำนวนในโทเค็น SLP
• float $amountToken - (ไม่บังคับ) จำนวนโทเค็นเสริมที่จะได้รับ
• string $tokenID - (ไม่บังคับ) hex id ของโทเค็น SLP จำเป็นถ้า $ umentToken> 0.

ส่งคืน bool - จริงในความสำเร็จเท็จเป็นอย่างอื่น

---

CreatePaymenturi (String $ address, float $ tumberbch, float $ tumberToken = 0.0, สตริง $ tokenid = ""): สตริง

ส่งคืน URI การชำระเงิน (เริ่มต้นด้วย "Bitcoincash:" หรือ "SimpleleDger:" ถ้า $ OcthenToken> 0) สำหรับที่อยู่ $ ที่กำหนด

• string $address - ที่อยู่ที่รับ BCH (หรือ SLP)
• float $amountBCH - จำนวนเงินใน BCH ที่จะได้รับ
• float $amountToken - (ไม่บังคับ) จำนวนโทเค็น SLP ที่จะได้รับ
• string $tokenID - (ไม่บังคับ) hex id ของโทเค็น SLP จำเป็นถ้า $ umentToken> 0.

ส่งคืน string

---

getBadgerButton (อาร์เรย์ $ btnconf, สตริง $ ที่อยู่, ลอย $ tumberBch, ลอย $ umentToken = 0.0, สตริง $ tokenid = ""): สตริง

รับรหัส HTML ของ BadgerButton ดู https://badger.bitcoin.com/

• array $btnConf - อาร์เรย์เชื่อมโยงกับ buttom config
  • ข้อความ (สตริง) ข้อความของปุ่ม
  • การโทรกลับ (สตริงเป็นทางเลือก) ชื่อของฟังก์ชั่นการโทรกลับที่มีอยู่ในหน้าต่างทั่วโลกที่จะเรียกหลังจากการชำระเงิน พารามิเตอร์: String chaintxid
  • CSSCLASS (String, เสริม) คลาส CSS เพิ่มเติมสำหรับปุ่ม
  • ForceIndLudeJS (บูล, เป็นตัวเลือก) เท็จเริ่มต้น - รวมไลบรารี JavaScript อีกครั้ง ใช้สิ่งนี้เฉพาะในกรณีที่คุณกำลังสร้าง HTML สำหรับหลาย ๆ หน้า
• string $address - ที่อยู่ที่รับ BCH (หรือ SLP)
• float $amountBCH - จำนวนเงินใน BCH ที่จะได้รับ
• float $amountToken - (ไม่บังคับ) จำนวนโทเค็น SLP ที่จะได้รับ
• string $tokenID - (ไม่บังคับ) hex id ของโทเค็น SLP จำเป็นถ้า $ umentToken> 0.

ส่งคืน string - ปุ่ม HTML

---

isvalidbchaddress (สตริง $ bchaddress): bool

ตรวจสอบว่าที่อยู่ BCH นั้นถูกต้องหรือไม่

• string $bchAddress - ที่อยู่ในรูปแบบ cashaddress เริ่มต้นด้วย 'bitcoincash:'

ส่งคืน bool - จริงถ้าที่อยู่นั้นถูกต้องเท็จเป็นอย่างอื่น

---

isvalidslpaddress (สตริง $ slpaddress): bool

ตรวจสอบว่าที่อยู่ SLP นั้นถูกต้องหรือไม่

• string $slpAddress - ที่อยู่เริ่มต้นด้วย 'SimpleleDger:'

ส่งคืน bool - จริงถ้าที่อยู่นั้นถูกต้องเท็จเป็นอย่างอื่น

---

getReturnaddress (ธุรกรรม $ tx): สตริง

รับที่อยู่ BCH return (เป็นของที่อยู่ผู้ส่งผู้ส่ง) ที่กำหนดเป็นที่อยู่สุดท้ายในเอาต์พุตการทำธุรกรรม

• Transaction $tx - การทำธุรกรรมจาก getTransaction () การโทร

ส่งคืน string - ที่อยู่

---

getReturnslpaddress (ธุรกรรม $ tx): สตริง

รับที่อยู่ SLP แบบส่งคืน (เป็นของที่อยู่ผู้ส่งผู้ส่ง) ที่กำหนดเป็นที่อยู่สุดท้ายในเอาต์พุตการทำธุรกรรม

• Transaction $tx - การทำธุรกรรมจาก getTransaction () การโทร

ส่งคืน string - ที่อยู่

---

Class Poppoptions

ชุดคุณสมบัติการกำหนดค่าขั้นสูง

• $httpAgent = null - การใช้งาน HTTP ที่ใช้ในการขอ HTTP ค่า: basichttpagent | curlhttpagent | wordpresshttpagent ค่าเริ่มต้นเป็น basichttpagent แต่คุณควรใช้ค่าที่ดีกว่าตามการตั้งค่า PHP ของคุณ
• $exchangeRateExpirationMin = 60 - อัตราแลกเปลี่ยนที่คลานอยู่ในแคชนานเท่าใด ปัจจุบันอัตราจะไม่ถูกบันทึกนอกเหนือจากการดำเนินการสคริปต์
• $httpTimeoutSec = 10 - หมดเวลาสำหรับคำขอ HTTP ไปยัง REST API Backend
• $blockchainApiImplementation = "BitcoinComRestApi" - การใช้งานแบ็กเอนด์ REST API ที่จะใช้ ค่าที่อนุญาต: bitcoincomrestapi | bchdprotogatewayapi | slpdbapi

การแลกเปลี่ยนชั้นเรียน

API เพื่อรับอัตราการแลกเปลี่ยน BCH ไปยังสกุลเงิน fiat

getrate (String $ currency = "USD"): Float

รับอัตราแลกเปลี่ยนปัจจุบันสำหรับ BCH

• string $currency - สกุลเงินคำสั่งเช่น USD | EUR | JPY

ส่งคืน float

---

คลาส blockchainapi

blockchain API เพื่อสร้างที่อยู่ตรวจสอบยอดคงเหลือการทำธุรกรรม ...

setlogger แบบคงที่ (callable $ loggerfn): เป็นโมฆะ

ตั้งค่าฟังก์ชั่น Logger สำหรับข้อผิดพลาดและเอาต์พุตดีบั๊ก ใช้สิ่งนี้เพื่อเขียนไปยัง LogFile หรือฐานข้อมูล หากไม่มีฟังก์ชั่นที่ให้ทุกอย่างจะถูกพิมพ์โดยใช้ 'echo'

• callable $loggerFn(string $subject, mixed $error, mixed $data = null) - พารามิเตอร์ของ php callable

sethttpagent (abstracthttpagent $ agent): เป็นโมฆะ

ตั้งค่าการใช้งาน AA HTTP สำหรับคำขอ (Curl, WordPress HTTP API, ... )

• AbstractHttpAgent $agent -

getConfirmationCount (สตริง $ transactionID): int

ส่งคืนจำนวนการยืนยันสำหรับรหัสธุรกรรม blockchain ที่กำหนด

• string $transactionID -

ส่งคืน int - จำนวนการยืนยันหรือ -1 หากไม่มีการทำธุรกรรม $

---

createNewAddress (สตริง $ xpub, int $ addressCount, สตริง $ hdpathformat = '0/%d'):? bchaddress

สร้างที่อยู่ใหม่จาก XPUB

• string $xPub - คีย์สาธารณะขยาย เรียกว่า 'คีย์สาธารณะหลัก' ในเงินสดอิเล็กตรอน
• int $addressCount - จำนวนที่อยู่ถัดไปเพื่อสร้างที่อยู่ที่ไม่ซ้ำกัน โดยปกติแล้วสิ่งนี้ควรเป็นจำนวนเต็มที่เพิ่มขึ้น
• string $hdPathFormat - (ไม่บังคับ) เส้นทาง HD ที่จะใช้สำหรับการสร้างที่อยู่เด็ก

ส่งคืน BchAddress - ที่อยู่หรือ null เมื่อความล้มเหลว

---

getTokenInfo (สตริง $ tokenid):? slptoken

รับข้อมูลทั่วไป (ทั่วทั้งเครือข่าย) เกี่ยวกับโทเค็น SLP

• string $tokenID -

ส่งคืน SlpToken - โทเค็นหรือ null เมื่อความล้มเหลว

---

getAddressBalance (ที่อยู่สตริง $): ลอยตัว

ส่งคืนยอดคงเหลือ BCH ของที่อยู่ที่กำหนด (รวมถึงธุรกรรมที่ไม่ได้รับการยืนยัน)

• string $address - ที่อยู่ BCH ในรูปแบบ CashAddress

ส่งคืน float - ยอดคงเหลือหรือ -1 หากไม่มีที่อยู่

---

getAddressTokenBalance (ที่อยู่สตริง $, สตริง $ tokenid): ลอย

ส่งคืนสมดุลโทเค็นของที่อยู่ SLP ที่กำหนด (รวมถึงธุรกรรมที่ไม่ได้รับการยืนยัน)

• string $address -
• string $tokenID -

ส่งคืน float - ยอดคงเหลือหรือ -1 หากไม่มีที่อยู่

---

getAddressDetails (ที่อยู่สตริง $):? bchaddress

ส่งคืนที่อยู่ BCH ด้วยคุณสมบัติทั้งหมดเช่น Balance, TXIDS, ...

• string $address - ที่อยู่ BCH ในรูปแบบ CashAddress

ส่งคืน BchAddress - ที่อยู่หรือ null เมื่อความล้มเหลว

---

getSlpaddressDetails (String $ address, String $ tokenid):? slptokenaddress

ส่งคืนรายละเอียดโทเค็น SLP ของที่อยู่ที่กำหนดรวมถึงยอดคงเหลือ, TXIDS, ...

• string $address -
• string $tokenID -

ส่งคืน SlpTokenAddress - โทเค็นหรือ null เมื่อความล้มเหลว

---

getTransaction (String $ transactionID):? ธุรกรรม

ส่งคืนธุรกรรมด้วยอินพุตและเอาต์พุตทั้งหมดรวมถึงข้อมูล SLP

• string $transactionID -

ส่งคืน Transaction - ธุรกรรมหรือ null เมื่อความล้มเหลว

---

การทดสอบ

ในการเรียกใช้การทดสอบหน่วยพิมพ์คำสั่งต่อไปนี้ในไดเรกทอรีรูทโครงการ (ต้องใช้ phpunit ติดตั้งโดยอัตโนมัติด้วยนักแต่งเพลง):

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

สิ่งที่ต้องทำ

• เพิ่มการตรวจสอบที่อยู่ SLP
• ใช้ฟังก์ชั่นเพิ่มเติมของส่วนที่เหลือ API
• ใช้การสร้างที่อยู่โดยใช้ XPUB ด้วย SLPDB (หลังจากรองรับ)

ติดต่อ

Twitter

ปลั๊กอิน WordPress