闪烁客户端
Brink 堆栈的 JavaScript 客户端库. 这被用在网络和移动钱包等前端应用中.
安装
以 :
pnpm add @blinkbitcoin/blink-client
使用量
解析付费列表
import { parsePaymentDestination } from "@blinkbitcoin/blink-client"
const { valid, paymentType, amount } = parsePaymentDestination({
destination: "username or invoice or bitcoin address",
network: "mainnet", // or signet or regtest
lnAddressDomains: ["blink.sv"],
})
有效的电话号码输入解析为闪电地址 pay.blink.sv 页:1
主网和 pay.staging.blink.sv 用于签名或重新测试。 设定
phoneNumberLnAddressDomain 只覆盖电话号码域 :
parsePaymentDestination({
destination: "+50370123456",
network: "mainnet",
lnAddressDomains: ["blink.sv"],
phoneNumberLnAddressDomain: "phone.example.com",
})
// lnurl: "[email protected]"
当一个QR代码或非手机手动输入与一个商家付款集成匹配时
结果仍然有效 PaymentType.Lnurl 包含 isMerchant: true 加一个
merchant 对象。 当输入匹配无法独到的多个集成时
由 displayCurrency,结果是:
{
paymentType: PaymentType.Merchant,
merchants: Merchant[],
}
每个商家包括其ID、闪电地址、类别、显示元数据以及一个
可选显示货币. category 仅是元数据; 消费者选择全部,
过滤、区域资格和政策决定.
PaymentType.Merchant 要求支付前选择消费者,不包括
valid 字段。 分会 paymentType 在依赖之前 valid 或开始支付.
测试
用 Jest 框架进行测试 :
pnpm test
构建
在其中构建生产(分发)文件 数字 文件夹 :
pnpm build
地方发展
使用 pnpm 数据
运行 :
pnpm link --global
在测试项目运行中:
pnpm link --global @blinkbitcoin/blink-client
如果您想要删除链接, 请运行 :
# in your test project
pnpm unlink @blinkbitcoin/blink-client
# in blinkbitcoin/client folder
pnpm unlink --global
使用雅尔克语
运行 :
# in blinkbitcoin/blink-client folder
yalc publish
在测试项目运行中 :
yalc add @blinkbitcoin/blink-client
如果您想要删除符号链接, 请运行 :
# in your test project
yalc remove @blinkbitcoin/blink-client
要更新更改,必须运行 yalc publish 运行前 :
# in your test project
yalc update