turing-wallet-provider 1.0.10 → 1.0.12

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/types/providerTypes.d.ts

@@ -1,98 +1,24 @@
 export type PubKey = {
     tbcPubKey: string;
-    // ordPubKey: string;
-    // identityPubKey: string;
 };
+
 export type Address = {
     tbcAddress: string;
-    // ordAddress: string;
-    // identityAddress: string;
 };
+
 export type Balance = {
     tbc: number;
-    // satoshis: number;
-    // usdInCents: number;
-};
-export type SocialProfile = {
-    displayName: string;
-    avatar: string;
-};
-export type OrdinalData = {
-    types?: string[];
-    insc?: Inscription;
-    map?: {
-        [key: string]: any;
-    };
-    b?: File;
-    sigma?: Sigma[];
-    list?: Listing;
-    tbc20?: Tbc20;
-    lock?: Lock;
-};
-export type Lock = {
-    address: string;
-    until: number;
-};
-export type Sigma = {
-    algorithm: string;
-    address: string;
-    signature: string;
-    vin: number;
-};
-export type Listing = {
-    price: number;
-    payout: string;
-};
-export type Tbc20 = {
-    id?: string;
-    p: string;
-    op: string;
-    tick?: string;
-    amt: string;
-    status?: Tbc20Status;
-};
-export type Origin = {
-    outpoint: string;
-    data?: OrdinalData;
-    num?: number;
-};
-export declare enum Tbc20Status {
-    Invalid = -1,
-    Pending = 0,
-    Valid = 1
-}
-export type File = {
-    type: string;
-    size: number;
-    hash: string;
-};
-export type Inscription = {
-    json?: any;
-    text?: string;
-    words?: string[];
-    file: File;
-};
-export type Ordinal = {
-    txid: string;
-    vout: number;
-    outpoint: string;
-    satoshis: number;
-    owner: string;
-    script: string;
-    spend: string;
-    origin: Origin;
-    height: number;
-    idx: number;
-    data: OrdinalData;
 };
+
 export type SignedMessage = {
     address: string;
     pubKey: string;
     sig: string;
     message: string;
-    derivationTag: DerivationTag;
 };
+
 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;
@@ -107,135 +33,24 @@ export type SendTransaction = {
     ft_amount?: number;
     merge_times?: number;
 };
-export type TransferOrdinal = {
-    address: string;
-    origin: string;
-    outpoint: string;
-};
-export type InternalTuringTags = {
-    label: "Turing";
-    id: "tbc";
-    domain: "";
-    meta: {};
-} | {
-    label: "Turing";
-    id: "ord";
-    domain: "";
-    meta: {};
-} | {
-    label: "Turing";
-    id: "identity";
-    domain: "";
-    meta: {};
-};
-export type DerivationTag = InternalTuringTags | {
-    label: string;
-    id: string;
-    domain: string;
-    meta?: Record<string, any>;
-};
+
 export type SignMessage = {
     message: string;
     encoding?: "utf8" | "hex" | "base64";
 };
-export type KeyTypes = "tbc" | "ord";
-export type Broadcast = {
-    rawtx: string;
-    fund?: boolean;
-};
-export type PurchaseOrdinal = {
-    outpoint: string;
-    marketplaceRate?: number;
-    marketplaceAddress?: string;
-};
+
 export type Utxos = {
     satoshis: number;
     script: string;
     txid: string;
     vout: number;
 };
-/**
- * `SignatureRequest` contains required informations for a signer to sign a certain input of a transaction.
- */
-export type SignatureRequest = {
-    prevTxid: string;
-    outputIndex: number;
-    /** The index of input to sign. */
-    inputIndex: number;
-    /** The previous output satoshis value of the input to spend. */
-    satoshis: number;
-    /** The address(es) of corresponding private key(s) required to sign the input. */
-    address: string | string[];
-    /** The previous output script of input, default value is a P2PKH locking script for the `address` if omitted. */
-    script?: string;
-    /** The sighash type, default value is `SIGHASH_ALL | SIGHASH_FORKID` if omitted. */
-    sigHashType?: number;
-    /**
-     * Index of the OP_CODESEPARATOR to split the previous output script at during verification.
-     * If undefined, the whole script is used.
-     * */
-    csIdx?: number;
-    /** The flag to distinguish the transaction.*/
-    flag: TransactionFlag;
-};
-/**
- * `SignatureResponse` contains the signing result corresponding to a `SignatureRequest`.
- */
-export type SignatureResponse = {
-    /** The index of input. */
-    inputIndex: number;
-    /** The signature.*/
-    sig: string;
-    /** The public key bound with the `sig`. */
-    pubKey: string;
-    /** The sighash type, default value is `SIGHASH_ALL | SIGHASH_FORKID` if omitted. */
-    sigHashType: number;
-    /** The index of the OP_CODESEPARATOR to split the previous output script at.*/
-    csIdx?: number;
-};
-/**
- * `SendTbcResponse` contains the result of sendTbc.
- */
+
 export type SendTransactionResponse = {
     txid: string;
     rawtx: string;
 };
-export type GetSignatures = {
-    rawtx: string;
-    sigRequests: SignatureRequest[];
-};
-export type TaggedDerivationRequest = {
-    label: string;
-    id: string;
-    meta?: Record<string, any>;
-};
-export type TaggedDerivationResponse = {
-    address: string;
-    pubKey: string;
-    tag: DerivationTag;
-};
-export type MimeTypes = "text/plain" | "text/html" | "text/css" | "application/javascript" | "application/json" | "application/xml" | "image/jpeg" | "image/png" | "image/gif" | "image/svg+xml" | "audio/mpeg" | "audio/wav" | "audio/wave" | "video/mp4" | "application/pdf" | "application/msword" | "application/vnd.ms-excel" | "application/vnd.ms-powerpoint" | "application/zip" | "application/x-7z-compressed" | "application/x-gzip" | "application/x-tar" | "application/x-bzip2";
-export type MAP = {
-    app: string;
-    type: string;
-    [prop: string]: string;
-};
-export type RawInscription = {
-    base64Data: string;
-    mimeType: MimeTypes;
-    map?: MAP;
-};
-export type InscribeRequest = {
-    address: string;
-    base64Data: string;
-    mimeType: MimeTypes;
-    map?: MAP;
-    satoshis?: number;
-};
-export type GetTaggedKeysRequest = {
-    label: string;
-    ids?: string[];
-};
+
 export type TuringProviderType = {
     isReady: boolean;
     connect: () => Promise<string | undefined>;
@@ -243,18 +58,8 @@ export type TuringProviderType = {
     isConnected: () => Promise<boolean>;
     getPubKey: () => Promise<PubKey | undefined>;
     getAddress: () => Promise<Address | undefined>;
-    // getSocialProfile: () => Promise<SocialProfile | undefined>;
     getBalance: () => Promise<Balance | undefined>;
-    // getOrdinals: () => Promise<Ordinal[] | undefined>;
     sendTransaction: (params: SendTransaction[]) => Promise<SendTransactionResponse | undefined>;
-    // transferOrdinal: (params: TransferOrdinal) => Promise<string | undefined>;
-    // purchaseOrdinal: (params: PurchaseOrdinal) => Promise<string | undefined>;
     signMessage: (params: SignMessage) => Promise<SignedMessage | undefined>;
-    // getSignatures: (params: GetSignatures) => Promise<SignatureResponse[] | undefined>;
-    broadcast: (params: Broadcast) => Promise<string | undefined>;
-    // getExchangeRate: () => Promise<number | undefined>;
     getPaymentUtxos: () => Promise<Utxos[] | undefined>;
-    // generateTaggedKeys: (params: TaggedDerivationRequest) => Promise<TaggedDerivationResponse>;
-    // getTaggedKeys: (params: GetTaggedKeysRequest) => Promise<TaggedDerivationResponse[] | undefined>;
-    // inscribe: (params: InscribeRequest[]) => Promise<SendTbcResponse | undefined>;
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "turing-wallet-provider",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [