bq-wallet
v1.0.3
Published
用于web钱包集合调用
Downloads
4
Readme
web3 钱包聚合库
结构
- 组件 WalletProvider 用于维持钱包数据上下文
- hooks 用于钱包 api 调用
WalletProvider 使用
import { WalletProvider } from "bq-wallet";
export default function Index() {
return <WalletProvider>{/* More JSX code here */}</WalletProvider>;
}
hooks
- useWallet 用于用于调用钱包 api 的。
- useWalletSelector 用于获取钱包数据
useWallet 提供的 api
- connect 用于连接钱包
- disconnect 用于断开钱包
- getInfo 用于获取余额
- sign 用于签名
- signPsbt 用于签名 psbt
- sendBitcoin 用于发送 btc
- getNetwork 用于获取钱包当前网络
- changeWallet 切换不同钱包或网络
import UseWalletComp "./UseWalletComp";
import { WalletProvider } from "bq-wallet";
export default function Index() {
return <WalletProvider>
<UseWalletComp />
</WalletProvider>;
}
// UseWalletComp
import { useWallet } from "bq-wallet";
export default function UseWalletComp() {
const {connect, disconnect, getInfo, sign, ... } = useWallet()
}
useWalletSelector 提供的数据
// 输出的ts类型
{
name: WalletName | null; // 钱包名称
network: Network; // 当前网络
publicKey: string; // 公钥
accounts: string[]; // 账户
address: string; // 钱包地址
btcAddress: string; // BTC钱包地址
btcPublicKey: string; // BTC钱包公钥
balance?: {
confirmed?: number; // 确认的余额
total?: number; // 总余额
unconfirmed?: number; // 未确认的余额
};
}
import UseWalletComp "./UseWalletComp";
import { WalletProvider } from "bq-wallet";
export default function Index() {
return <WalletProvider>
<UseWalletComp />
</WalletProvider>;
}
// UseWalletComp
import { useWalletSelector } from "bq-wallet";
export default function UseWalletComp() {
const walletInfo = useWalletSelector()
}
Api 部分
- stringFormatTransition 用于 hex 与 base64 的转换
- getBase64Str 获取 base64 字符串
- getHexStr 获取 hex 字符串
- detectEncoding 判断字符串类型
- btcToSatoshis 用于 btc 转成 satoshis
- satoshisToBtc 用于 btc 转成 satoshis