unwallet-client-sdk 0.12.0 → 0.14.0

package/.github/workflows/publish.yml

@@ -10,8 +10,6 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: 8
       - name: Prepare to cache dependencies
         shell: bash
         run: |

package/README.md

@@ -20,4 +20,4 @@ const unWallet = await UnWallet.init({
 
 ## Usage
 
-See [Functions](docs/functions.md).
+https://developers.ent.unwallet.world/01_spec/02_client-side-sdk

package/dist/unwallet.d.ts

@@ -18,13 +18,14 @@ export declare class UnWallet {
     }): void;
     sign(args: {
         message: string;
+        ticketToken: string;
     }): Promise<SignResult>;
     sendTransaction(args: {
         chainID: number;
         toAddress: string;
         value?: string;
         data?: string;
-        ticket: string;
+        ticketToken: string;
     }): Promise<SendTransactionResult>;
     private getConnectionID;
     private sendWSMessage;

package/dist/unwallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unwallet.d.ts","sourceRoot":"","sources":["../src/unwallet.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,MAAM,EACN,cAAc,EACd,UAAU,EACV,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,cAAc,CAAiB;IAEvC,OAAO,CAAC,EAAE,CAAY;IACtB,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,OAAO,CAAwC;IACvD,OAAO,CAAC,MAAM,CAAwC;gBAE1C,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,EAAE,EAAE,SAAS;IAUzE,OAAO,CAAC,eAAe;WAKT,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsC9C,SAAS,CAAC,IAAI,EAAE;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI;IA2BD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAqBpD,eAAe,CAAC,IAAI,EAAE;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAkClC,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,eAAe;IA4BvB,OAAO,CAAC,UAAU;CAYnB"}
+{"version":3,"file":"unwallet.d.ts","sourceRoot":"","sources":["../src/unwallet.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,MAAM,EACN,cAAc,EACd,UAAU,EACV,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,cAAc,CAAiB;IAEvC,OAAO,CAAC,EAAE,CAAY;IACtB,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,OAAO,CAAwC;IACvD,OAAO,CAAC,MAAM,CAAwC;gBAE1C,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,EAAE,EAAE,SAAS;IAUzE,OAAO,CAAC,eAAe;WAKT,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsC9C,SAAS,CAAC,IAAI,EAAE;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI;IA2BD,IAAI,CAAC,IAAI,EAAE;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,UAAU,CAAC;IAsBhB,eAAe,CAAC,IAAI,EAAE;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAkClC,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,eAAe;IA4BvB,OAAO,CAAC,UAAU;CAYnB"}

package/dist/unwallet.js

@@ -82,6 +82,7 @@ class UnWallet {
                 url.searchParams.set("connectionID", this.connectionID);
                 url.searchParams.set("clientID", this.config.clientID);
                 url.searchParams.set("message", args.message);
+                url.searchParams.set("ticketToken", args.ticketToken);
             }
             this.openWindow(url);
         });
@@ -103,7 +104,7 @@ class UnWallet {
                 url.searchParams.set("toAddress", args.toAddress);
                 url.searchParams.set("value", args.value !== undefined ? args.value : "0x0");
                 url.searchParams.set("data", args.data !== undefined ? args.data : "0x");
-                url.searchParams.set("ticket", args.ticket);
+                url.searchParams.set("ticketToken", args.ticketToken);
             }
             this.openWindow(url);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unwallet-client-sdk",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "unWallet client-side SDK",
   "license": "MIT",
   "author": "SIVIRA",
@@ -15,15 +15,15 @@
     }
   },
   "dependencies": {
-    "ethers": "6.13.1"
+    "ethers": "6.13.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "19.3.0",
-    "@commitlint/config-conventional": "19.2.2",
-    "commitizen": "4.3.0",
+    "@commitlint/cli": "19.7.1",
+    "@commitlint/config-conventional": "19.7.1",
+    "commitizen": "4.3.1",
     "cz-conventional-changelog": "3.3.0",
-    "husky": "9.0.11",
-    "typescript": "5.5.2"
+    "husky": "9.1.7",
+    "typescript": "5.7.3"
   },
   "scripts": {
     "build": "tsc",

package/src/unwallet.ts

@@ -104,7 +104,10 @@ export class UnWallet {
     location.assign(url.toString());
   }
 
-  public sign(args: { message: string }): Promise<SignResult> {
+  public sign(args: {
+    message: string;
+    ticketToken: string;
+  }): Promise<SignResult> {
     return new Promise((resolve, reject) => {
       this.resolve = (sig: string) => {
         resolve({
@@ -119,6 +122,7 @@ export class UnWallet {
         url.searchParams.set("connectionID", this.connectionID);
         url.searchParams.set("clientID", this.config.clientID);
         url.searchParams.set("message", args.message);
+        url.searchParams.set("ticketToken", args.ticketToken);
       }
 
       this.openWindow(url);
@@ -130,7 +134,7 @@ export class UnWallet {
     toAddress: string;
     value?: string;
     data?: string;
-    ticket: string;
+    ticketToken: string;
   }): Promise<SendTransactionResult> {
     return new Promise((resolve, reject) => {
       if (args.value === undefined && args.data === undefined) {
@@ -158,7 +162,7 @@ export class UnWallet {
           "data",
           args.data !== undefined ? args.data : "0x"
         );
-        url.searchParams.set("ticket", args.ticket);
+        url.searchParams.set("ticketToken", args.ticketToken);
       }
 
       this.openWindow(url);

package/docs/functions.md

@@ -1,118 +0,0 @@
-# Functions
-
-> **Note**\
-> You need to register your application to unWallet Enterprise in advance.
-
-## authorize
-
-`authorize` requests a user's ID token in accordance with OpenID Connect (response_type: id_token).
-
-### Example call
-
-```js
-unWallet.authorize({
-  redirectURL: "http://your.app.com/callback",
-  nonce: "ARBITRARY_STRING_TO_PREVENT_REPLAY_ATTACKS",
-});
-```
-
-## sign
-
-`sign` requests a signature for a message.
-
-### Example call
-
-```js
-const result = await unWallet.sign({
-  message: "ARBITRARY_MESSAGE",
-});
-```
-
-### Example result
-
-```json
-{
-  "digest": "0xc71ed5b0509d8da72abc9527ed72530743822e8d9b33f9695b42e20ece78c09b",
-  "signature": "0xd94388b5d51395c46b00f6197de318ba275cd7f9c5e4dccf2059373a4b41b3975403852e2587f262375e6d2b3318380dcd95535ecebec7e8c7ebbbefdcf22a371b"
-}
-```
-
-### How to verify a signature
-
-See also [ERC1271](https://eips.ethereum.org/EIPS/eip-1271).
-
-```js
-const ethers = require("ethers");
-
-(async () => {
-  const contract = new ethers.Contract(
-    "<CONTRACT_WALLET_ADDRESS>",
-    [
-      {
-        inputs: [
-          {
-            internalType: "bytes32",
-            name: "hash",
-            type: "bytes32",
-          },
-          {
-            internalType: "bytes",
-            name: "signature",
-            type: "bytes",
-          },
-        ],
-        name: "isValidSignature",
-        outputs: [
-          {
-            internalType: "bytes4",
-            name: "",
-            type: "bytes4",
-          },
-        ],
-        stateMutability: "view",
-        type: "function",
-      },
-    ],
-    new ethers.providers.JsonRpcProvider("<YOUR_RPC_URL>")
-  );
-
-  try {
-    await contract.isValidSignature("<DIGEST>", "<SIGNATURE>");
-  } catch (e) {
-    console.log("invalid");
-    return;
-  }
-
-  console.log("valid");
-})();
-```
-
-## sendTransaction
-
-`sendTransaction` requests to send a transaction.
-
-### Example call
-
-> **Note**\
-> You need to issue a transaction ticket via unWallet Enterprise API in advance.
-
-```js
-const result = await unWallet.sendTransaction({
-  chainID: 80002,
-  toAddress: "0xC2C747E0F7004F9E8817Db2ca4997657a7746928",
-  value: "0xde0b6b3a7640000", // the amount of native token to be transferred
-  ticket:
-    "eyJhbGciOiJFUzI1NiIsImtpZCI6IjEiLCJ0eXAiOiJKV1QifQ.eyJhcGlDbGllbnRJRCI6IlFWQkpRMnhwWlc1ME9qRT0iLCJjaGFpbklEIjo4MDAwMiwiY2xpZW50SUQiOiJDWHFsSnBLWWlYTHpWdXEzbVU0OVVZNVVGbjJOM1VSVnQiLCJleHAiOjE3MTk0OTM3NzEsImlhdCI6MTcxOTQ5MzcxMSwiaWQiOiJkYjA1OTQ1MDI4MDQ4MWQ1ZjMxOWNlZWIwZTJkMjQ4MTNkNjc4OTdlODA1MGU1YTVmNWIyZWJkNzUxYmMwM2Y5IiwicGF5bWVudFR5cGUiOiJ1c2VyIiwidHJhbnNhY3Rpb25EYXRhIjoiMHgiLCJ0cmFuc2FjdGlvbkZyb21BZGRyZXNzIjoiMHgxMDVmNDMxMGIzRDE4RTNEN0YxOWZEN0RGNDg4NzM1YTE1MGVlZDJhIiwidHJhbnNhY3Rpb25Ub0FkZHJlc3MiOiIweEMyQzc0N0UwRjcwMDRGOUU4ODE3RGIyY2E0OTk3NjU3YTc3NDY5MjgiLCJ0cmFuc2FjdGlvblZhbHVlIjoiMHhkZTBiNmIzYTc2NDAwMDAifQ.LIzAe8Ar3c0KNWf0bczVUDodMj6pwwWngESC7AaWI9PHbmeQ6q3zsXgFJm__pi1mLJ79fHZfI0DF4fjreUDZtQ",
-});
-```
-
-### Example result
-
-```json
-{
-  "transactionID": "UXVldWVkVHJhbnNhY3Rpb246MQ=="
-}
-```
-
-> **Note**\
-> You can get the transaction detail via unWallet Enterprise API.