turing-wallet-provider 1.0.11 → 1.0.13

package/README.md

@@ -0,0 +1,300 @@
+### connect
+
+```tsx
+npm install turing-wallet-provider@latest
+
+import { TuringProvider } from "turing-wallet-provider";
+
+root.render(
+  <TuringProvider>
+    <App />
+  </TuringProvider>
+);
+```
+
+```tsx
+import { useTuringsWallet } from 'turing-wallet-provider';
+
+const wallet = useTuringsWallet();
+await wallet.connect();
+```
+
+### disconnect
+
+```tsx
+const wallet = useTuringsWallet();
+await wallet.disconnect();
+```
+
+### isConnected
+
+```tsx
+const wallet = useTuringsWallet();
+const ture/false = await wallet.isConnected();
+```
+
+### getPubKey
+
+```tsx
+const wallet = useTuringsWallet();
+const {tbcPubKey} = await wallet.getPubKey(); //tbcPubKey为string类型
+```
+
+### getAddress
+
+```tsx
+const wallet = useTuringsWallet();
+const {tbcAddress} = await wallet.getAddress(); //tbcAddress为string类型
+```
+
+### getBalance
+
+```tsx
+const wallet = useTuringsWallet();
+const {tbc} = await wallet.getBalance();//tbc为number类型，单位为tbc
+```
+
+### getPaymentUtxos
+
+```tsx
+const wallet = useTuringsWallet();
+try {
+    const utxos = await wallet.getPaymentUtxos();
+    console.log(utxos);
+} catch (err) {
+    console.log(err);
+}
+
+[
+    {
+        satoshis: 205551
+        script: "76a914b681d8032b448405d44e82807fab2c8894eed57788ac"
+        txid: "c58e8b0dd25e56af0696b026c1961dccd0cab3fe42fb2f3ac934ebdc3accbb40"
+        vout: 0
+    },
+    {
+        satoshis: 19909
+        script: "76a914b681d8032b448405d44e82807fab2c8894eed57788ac"
+        txid: "4c52add57a2c9cda29501a810a1312eaee9423d28440a09acbf5d9d8d0467382"
+        vout: 0
+    }
+]//模拟的输出
+```
+
+### signMessage
+
+```tsx
+const wallet = useTuringsWallet();
+try{
+    const { address, pubKey, sig, message } = await wallet.signMessage({ message: "hello world", encoding: "base64" });//encoding可为utf-8,base64,hex
+}catch(error){
+    console.log(err);
+}
+
+//本地验证签名
+import * as tbc from "tbc-lib-js"
+
+const msg_buf = Buffer.from(message,encoding);
+const true/false = tbc.Message.verify(msg_buf,address,sig);
+```
+
+### sendTransaction
+
+```tsx
+interface FTData {
+​	name :string;
+    symbol :string;
+​	decimal :number;
+​	amount :number;
+};
+
+interface CollectionData {
+    collectionName: string;
+    description: string;
+    supply: number;
+    file: string;//file为图片base64编码后数据
+};
+
+interface NFTData {
+    nftName: string;
+    symbol: string;
+    discription: string;
+    attributes: string;
+    file?: string;//file为图片base64编码后数据,若无则为引用合集图片
+};
+
+interface RequestParam = {
+    flag: "P2PKH" | "COLLECTION_CREATE" | "NFT_CREATE" | "NFT_TRANSFER" | "FT_MINT" | "FT_TRANSFER" | "POOLNFT_MINT" | "POOLNFT_INIT" | "POOLNFT_LP_INCREASE" |"POOLNFT_LP_CONSUME"| "POOLNFT_SWAP_TO_TOKEN" | "POOLNFT_SWAP_TO_TBC" | "POOLNFT_MERGE"|"FTLP_MERGE";
+    address？: string;//交易接收者地址
+    satoshis?: number;//单位为satoshis
+    collection_data?: string; //json格式传
+    ft_data?: string; //json格式传
+    nft_data?: string;	//json格式传
+    collection_id?: string;
+    nft_contract_address?: string;
+    ft_contract_address?: string;
+    tbc_amount?: number;
+    ft_amount?: number;
+    merge_times?:number;
+};
+
+const params = [param:RequestParam] //目前参数里只能放一个对象，有批量发送需求再扩展
+```
+
+#### P2PKH
+
+```
+const params = [{
+	flag:"P2PKH",
+    satoshis: 1000,
+    address: "",
+}] ;
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### COLLECTION_CREATE
+
+```
+const params = [{
+	flag:"COLLECTION_CREATE",
+    collection_data:"",
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### NFT_CREATE
+
+```
+const params = [{
+	flag:"NFT_CREATE",
+    nft_data:"",
+    collection_id:""
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### NFT_TRANSFER
+
+```ts
+const params = [{
+	flag:"NFT_TRANSFER",
+    nft_contract_address:"",
+    address:""
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### FT_MINT
+
+```
+const params = [{
+	flag:"FT_MINT",
+    ft_data:""
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### FT_TRANSFER
+
+```
+const params = [{
+	flag:"FT_TRANSFER",
+    ft_contract_address:"",
+    ft_amount:0.1,
+    address::""
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_MINT
+
+```
+const params = [{
+	flag:"POOLNFT_MINT",
+    ft_contract_address:"",
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_INIT
+
+```
+const params = [{
+	flag:"POOLNFT_INIT",
+    nft_contract_address:"",
+    address:"",
+    tbc_amount:30,
+    ft_amount:1000
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_LP_INCREASE
+
+```
+const params = [{
+	flag:"POOLNFT_LP_INCREASE",
+    nft_contract_address:"",
+    address:"",
+    tbc_amount:3
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_LP_CONSUME
+
+```
+const params = [{
+	flag:"POOLNFT_LP_CONSUME",
+    nft_contract_address:"",
+    address:""
+    ft_amount:100
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_SWAP_TO_TOKEN
+
+```
+const params = [{
+	flag:"POOLNFT_SWAP_TO_TOKEN",
+    nft_contract_address:"",
+    address:"",
+    tbc_amount:10
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_SWAP_TO_TBC
+
+```
+const params = [{
+	flag:"POOLNFT_SWAP_TO_TBC",
+    nft_contract_address:"",
+    address:"",
+    ft_amount:10 
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### POOLNFT_MERGE
+
+```
+const params = [{
+	flag:"POOLNFT_MERGE",
+    nft_contract_address:"",
+    merge_times:1; //1-10次
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+
+#### FTLP_MERGE
+
+```
+const params = [{
+	flag:"POOLNFT_MERGE",
+    nft_contract_address:""
+}];
+const { txid, rawtx } = await wallet.sendTransaction(params);
+```
+

package/dist/context/TuringWalletContext.d.ts

@@ -1,8 +1,8 @@
-import { ReactNode } from "react";
-import { TuringProviderType } from "../types/providerTypes"
-export declare const TuringContext: import("react").Context<TuringProviderType | undefined>;
-interface TuringProviderProps {
-    children: ReactNode;
-}
-export declare const TuringProvider: (props: TuringProviderProps) => import("react/jsx-runtime").JSX.Element;
-export { };
+import { ReactNode } from "react";
+import { TuringProviderType } from "../types/providerTypes"
+export declare const TuringContext: import("react").Context<TuringProviderType | undefined>;
+interface TuringProviderProps {
+    children: ReactNode;
+}
+export declare const TuringProvider: (props: TuringProviderProps) => import("react/jsx-runtime").JSX.Element;
+export { };

package/dist/context/TuringWalletContext.js

@@ -1,24 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TuringProvider = exports.TuringContext = void 0;
-var jsx_runtime_1 = require("react/jsx-runtime");
-var react_1 = require("react");
-exports.TuringContext = (0, react_1.createContext)(undefined);
-var TuringProvider = function (props) {
-    var children = props.children;
-    // It takes a moment for the Turing wallet to get injected into the DOM. To use context we need an initial state;
-    var _a = (0, react_1.useState)({ isReady: false }), TuringWallet = _a[0], setTuringWallet = _a[1];
-    (0, react_1.useEffect)(function () {
-        var checkTuringWallet = function () {
-            var _a;
-            if ("Turing" in window && ((_a = window.Turing) === null || _a === void 0 ? void 0 : _a.isReady)) {
-                setTuringWallet(window.Turing);
-            }
-        };
-        checkTuringWallet();
-        var intervalId = setInterval(checkTuringWallet, 1000);
-        return function () { return clearInterval(intervalId); };
-    }, []);
-    return ((0, jsx_runtime_1.jsx)(exports.TuringContext.Provider, { value: TuringWallet, children: children }));
-};
-exports.TuringProvider = TuringProvider;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TuringProvider = exports.TuringContext = void 0;
+var jsx_runtime_1 = require("react/jsx-runtime");
+var react_1 = require("react");
+exports.TuringContext = (0, react_1.createContext)(undefined);
+var TuringProvider = function (props) {
+    var children = props.children;
+    // It takes a moment for the Turing wallet to get injected into the DOM. To use context we need an initial state;
+    var _a = (0, react_1.useState)({ isReady: false }), TuringWallet = _a[0], setTuringWallet = _a[1];
+    (0, react_1.useEffect)(function () {
+        var checkTuringWallet = function () {
+            var _a;
+            if ("Turing" in window && ((_a = window.Turing) === null || _a === void 0 ? void 0 : _a.isReady)) {
+                setTuringWallet(window.Turing);
+            }
+        };
+        checkTuringWallet();
+        var intervalId = setInterval(checkTuringWallet, 1000);
+        return function () { return clearInterval(intervalId); };
+    }, []);
+    return ((0, jsx_runtime_1.jsx)(exports.TuringContext.Provider, { value: TuringWallet, children: children }));
+};
+exports.TuringProvider = TuringProvider;

package/dist/hook/useTuringWallet.d.ts

@@ -1 +1 @@
-export declare const useTuringWallet: () => import("..").TuringProviderType;
+export declare const useTuringWallet: () => import("..").TuringProviderType;

package/dist/hook/useTuringWallet.js

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useTuringWallet = void 0;
-var react_1 = require("react");
-var TuringWalletContext_1 = require("../context/TuringWalletContext");
-var useTuringWallet = function () {
-    var context = (0, react_1.useContext)(TuringWalletContext_1.TuringContext);
-    if (!context) {
-        throw new Error("useTuringWallet must be used within a TuringProvider");
-    }
-    return context;
-};
-exports.useTuringWallet = useTuringWallet;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTuringWallet = void 0;
+var react_1 = require("react");
+var TuringWalletContext_1 = require("../context/TuringWalletContext");
+var useTuringWallet = function () {
+    var context = (0, react_1.useContext)(TuringWalletContext_1.TuringContext);
+    if (!context) {
+        throw new Error("useTuringWallet must be used within a TuringProvider");
+    }
+    return context;
+};
+exports.useTuringWallet = useTuringWallet;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./context/TuringWalletContext";
-export * from "./hook/useTuringWallet";
-export * from "./types/providerTypes";
+export * from "./context/TuringWalletContext";
+export * from "./hook/useTuringWallet";
+export * from "./types/providerTypes";

package/dist/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./context/TuringWalletContext"), exports);
-__exportStar(require("./hook/useTuringWallet"), exports);
-__exportStar(require("./types/providerTypes"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./context/TuringWalletContext"), exports);
+__exportStar(require("./hook/useTuringWallet"), exports);
+__exportStar(require("./types/providerTypes"), exports);

package/dist/types/providerTypes.d.ts

@@ -1,65 +1,87 @@
-export type PubKey = {
-    tbcPubKey: string;
-};
-
-export type Address = {
-    tbcAddress: string;
-};
-
-export type Balance = {
-    tbc: number;
-};
-
-export type SignedMessage = {
-    address: string;
-    pubKey: string;
-    sig: string;
-    message: string;
-};
-
-export type TransactionFlag = "P2PKH" | "COLLECTION_CREATE" | "NFT_CREATE" | "NFT_TRANSFER" | "FT_MINT" | "FT_TRANSFER" | "POOLNFT_MINT" | "POOLNFT_INIT" | "POOLNFT_LP_INCREASE" | "POOLNFT_LP_CONSUME" | "POOLNFT_SWAP_TO_TOKEN" | "POOLNFT_SWAP_TO_TBC" | "POOLNFT_MERGE" | "FTLP_MERGE";
-
-export type SendTransaction = {
-    flag: TransactionFlag;
-    satoshis?: number;
-    address?: string;
-    collection_data?: string;
-    ft_data?: string;
-    nft_data?: string;
-    collection_id?: string;
-    nft_contract_address?: string;
-    ft_contract_address?: string;
-    tbc_amount?: number;
-    ft_amount?: number;
-    merge_times?: number;
-};
-
-export type SignMessage = {
-    message: string;
-    encoding?: "utf8" | "hex" | "base64";
-};
-
-export type Utxos = {
-    satoshis: number;
-    script: string;
-    txid: string;
-    vout: number;
-};
-
-export type SendTransactionResponse = {
-    txid: string;
-    rawtx: string;
-};
-
-export type TuringProviderType = {
-    isReady: boolean;
-    connect: () => Promise<string | undefined>;
-    disconnect: () => Promise<boolean>;
-    isConnected: () => Promise<boolean>;
-    getPubKey: () => Promise<PubKey | undefined>;
-    getAddress: () => Promise<Address | undefined>;
-    getBalance: () => Promise<Balance | undefined>;
-    sendTransaction: (params: SendTransaction[]) => Promise<SendTransactionResponse | undefined>;
-    signMessage: (params: SignMessage) => Promise<SignedMessage | undefined>;
-    getPaymentUtxos: () => Promise<Utxos[] | undefined>;
-}
+export type PubKey = {
+    tbcPubKey: string;
+};
+
+export type Address = {
+    tbcAddress: string;
+};
+
+export type Balance = {
+    tbc: number;
+};
+
+export type SignedMessage = {
+    address: string;
+    pubKey: string;
+    sig: string;
+    message: string;
+};
+
+export type TransactionFlag = "P2PKH" | "COLLECTION_CREATE" | "NFT_CREATE" | "NFT_TRANSFER" | "FT_MINT" | "FT_TRANSFER" | "POOLNFT_MINT" | "POOLNFT_INIT" | "POOLNFT_LP_INCREASE" | "POOLNFT_LP_CONSUME" | "POOLNFT_SWAP_TO_TOKEN" | "POOLNFT_SWAP_TO_TBC" | "POOLNFT_MERGE" | "FTLP_MERGE";
+
+export type SendTransaction = {
+    flag: TransactionFlag;
+    satoshis?: number;
+    address?: string;
+    collection_data?: string;
+    ft_data?: string;
+    nft_data?: string;
+    collection_id?: string;
+    nft_contract_address?: string;
+    ft_contract_address?: string;
+    tbc_amount?: number;
+    ft_amount?: number;
+    merge_times?: number;
+};
+
+export type SignMessage = {
+    message: string;
+    encoding?: "utf8" | "hex" | "base64";
+};
+
+export type Utxos = {
+    satoshis: number;
+    script: string;
+    txid: string;
+    vout: number;
+};
+
+export type SendTransactionResponse = {
+    txid: string;
+    rawtx: string;
+};
+
+export type Encrypt = {
+    message: string;
+    pubKey: string;
+    encoding?: 'utf8' | 'hex' | 'base64';
+};
+
+export type Decrypt = {
+    message: string;
+    encoding?: 'utf8' | 'hex' | 'base64';
+};
+
+export type EncryptResponse = {
+    encryptedMessage: string;
+};
+
+export type DecryptResponse = {
+    decryptedMessage: string;
+};
+
+
+export type TuringProviderType = {
+    isReady: boolean;
+    connect: () => Promise<string | undefined>;
+    disconnect: () => Promise<boolean>;
+    isConnected: () => Promise<boolean>;
+    getPubKey: () => Promise<PubKey | undefined>;
+    getAddress: () => Promise<Address | undefined>;
+    getBalance: () => Promise<Balance | undefined>;
+    sendTransaction: (params: SendTransaction[]) => Promise<SendTransactionResponse | undefined>;
+    signMessage: (params: SignMessage) => Promise<SignedMessage | undefined>;
+    getPaymentUtxos: () => Promise<Utxos[] | undefined>;
+    encrypt: (params: Encrypt) => Promise<EncryptResponse | undefined>;
+    decrypt: (params: Decrypt) => Promise<DecryptResponse | undefined>;
+}

package/dist/types/providerTypes.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tbc20Status = void 0;
-var Tbc20Status;
-(function (Tbc20Status) {
-    Tbc20Status[Tbc20Status["Invalid"] = -1] = "Invalid";
-    Tbc20Status[Tbc20Status["Pending"] = 0] = "Pending";
-    Tbc20Status[Tbc20Status["Valid"] = 1] = "Valid";
-})(Tbc20Status || (exports.Tbc20Status = Tbc20Status = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tbc20Status = void 0;
+var Tbc20Status;
+(function (Tbc20Status) {
+    Tbc20Status[Tbc20Status["Invalid"] = -1] = "Invalid";
+    Tbc20Status[Tbc20Status["Pending"] = 0] = "Pending";
+    Tbc20Status[Tbc20Status["Valid"] = 1] = "Valid";
+})(Tbc20Status || (exports.Tbc20Status = Tbc20Status = {}));

package/package.json

@@ -1,31 +1,31 @@
-{
-  "name": "turing-wallet-provider",
-  "version": "1.0.11",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc"
-  },
-  "peerDependencies": {
-    "react": ">=17.0.0",
-    "react-dom": ">=17.0.0"
-  },
-  "devDependencies": {
-    "typescript": "^4.5.0",
-    "@types/react": "^17.0.0",
-    "@types/react-dom": "^17.0.0"
-  },
-  "keywords": [
-    "wallet",
-    "turing",
-    "tbc",
-    "bitcoin",
-    "turing wallet"
-  ],
-  "author": "Joe",
-  "license": "ISC",
-  "description": "A provider that makes interacting with Turing Wallet a walk in the park."
+{
+  "name": "turing-wallet-provider",
+  "version": "1.0.13",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.5.0",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0"
+  },
+  "keywords": [
+    "wallet",
+    "turing",
+    "tbc",
+    "bitcoin",
+    "turing wallet"
+  ],
+  "author": "Joe",
+  "license": "ISC",
+  "description": "A provider that makes interacting with Turing Wallet a walk in the park."
 }