turing-wallet-provider 1.0.0 → 1.0.2

package/README.md

@@ -2,14 +2,15 @@
 
 ## Description
 
-The Turing Wallet Provider simplifies the process of integrating Turing Wallet into your react application by creating a provider that wraps your application.
+The Turing Wallet Provider simplifies the process of integrating [Turing Wallet](https://chromewebstore.google.com/detail/turing-wallet/hmodlkcjggjgfalgdgbflhefijojdjen?hl=zh-CN&utm_source=ext_sidebar) into your react application by creating a provider that wraps your application.
 
 ## Installation
 
-Install the package using npm:
+Install the package using npm/yarn:
 
 ```sh
 npm install turing-wallet-provider
+yarn add turing-wallet-provider
 ```
 
 ## Usage
@@ -51,4 +52,121 @@ function YourComponent() {
 }
 ```
 
+### Provider Api
 
+#####  GettingAdresses & Public Keys
+
+After establishing a connection, you'll likely need to know the user's addresses and public keys at some point.
+
+```tsx
+const { tbcAddress, ordAddress, identityAddress } = await wallet.getAddresses();
+const { tbcPubKey, ordPubKey, identityPubKey } = await wallet.getPubKeys();
+```
+
+##### Send TBC
+
+Before send TBC to a Bitcoin address(es), you may simply pass an `array` of payment objects.
+
+```tsx
+const { txid, rawtx } = await wallet.sendBsv(paymentParams);
+```
+
+##### Get UTXOs
+
+```tsx
+const utxos = await wallet.getPaymentUtxos();
+```
+
+##### Get Social Profile
+
+After establishing a connection, your application may want to pull in certain social preferences like a user Display Name or Avatar.
+
+```tsx
+const { displayName, avatar } = await wallet.getSocialProfile();
+```
+
+##### Get Balance
+
+```tsx
+const { tbc, satoshis, usdInCents } = await wallet.getBalance();
+```
+
+##### Get Exchange Rate
+
+Fetch the TBC exchange rate in USD.
+
+```tsx
+const rate = await wallet.getExchangeRate();
+```
+
+##### Disconnect the Provider
+
+Turing Wallet will whitelist the requesting applications domain. To sever this connection you can simply call `disconnect()`. 
+
+```tsx
+await wallet.disconnect()
+```
+
+##### Broadcast Raw Tx
+
+You will need to pass an object that contains the rawtx:
+
+```tsx
+{
+    rawtx: string
+    fund?: boolean;
+}
+```
+
+Passing the optional fund param will add and sign inputs from the user's Turing Wallet along with calculating and applying the appropriate change for the tx.
+
+```tsx
+const param = {
+  rawtx:"xxx",
+};
+const txid = await wallet.broadcast(param);
+```
+
+##### Sign Message
+
+To transmit a message for user signing you must pass an object that contains a message. You can also pass an optional encoding param for more advanced signings:
+
+```tsx
+{
+  message: string;
+  encoding?: "utf8" | "hex" | "base64" ;
+};
+const message = { message: "Hello world" };
+const response = await panda.signMessage(message);
+```
+
+##### Get Signatures
+
+```tsx
+  const sigRequests: SignatureRequest[] = [
+  { 
+    prevTxid: 
+    outputIndex: 0,
+    inputIndex: 0,
+    satoshis: 1,
+    address: 
+  },
+  { 
+    prevTxid: 
+    outputIndex: 0,
+    inputIndex: 1,
+    satoshis: 1000,
+    address: 
+    script: 
+  }
+];
+
+const sigResponses: SignatureResponse[] = await wallet.getSignatures({
+  rawtx: 
+  sigRequests
+});
+```
+
+# Demo
+
+[turing-wallet-sample](https://github.com/TuringBitChain/turing-wallet-sample)

package/dist/hook/useTuringWallet.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useTuringWallet = void 0;
 var react_1 = require("react");
-var TuringWalletContext_1 = require("/dist/context/TuringWalletContext");
+var TuringWalletContext_1 = require("../context/TuringWalletContext");
 var useTuringWallet = function () {
     var context = (0, react_1.useContext)(TuringWalletContext_1.TuringContext);
     if (!context) {

package/package.json

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