unwallet-client-sdk 0.2.0 → 0.4.1

package/README.md

@@ -1,6 +1,6 @@
 # unWallet client-side SDK
 
-:warning: Works fine only on browsers
+:warning: This SDK works fine only on browsers.
 
 ## Installation
 
@@ -8,11 +8,7 @@
 $ npm install unwallet-client-sdk
 ```
 
-## Example
-
-To execute the sample codes below, you need to create an application with unWallet Enterprise in advance.
-
-### Initialization
+## Initialization
 
 ```js
 import { UnWallet } from "unwallet-client-sdk";
@@ -22,31 +18,7 @@ const unWallet = await UnWallet.init({
 });
 ```
 
-### Requesting a user's ID token in accordance with OpenID Connect (response_type: id_token)
-
-```js
-unWallet.authorize({
-  redirectURL: "http://your.app.com/callback",
-  nonce: "pdITKAtep0pfPOrUXdzjqW6gKvXezurJ", // arbitrary string to prevent replay attacks
-});
-```
-
-### Requesting a signature for a message
-
-```js
-const sig = await unWallet.sign({
-  message: "ARBITRARY_MESSAGE",
-});
-```
-
-### Requesting a signature for a token transfer transaction
-
-```js
-const metaTx = await unWallet.signTokenTransfer({
-  id: 1, // token ID
-  to: "0x0000000000000000000000000000000000000000", // destination address
-  amount: 1, // token amount
-});
-```
+## Functions
 
-To execute the transaction, call [POST /metaTransactions of unWallet Enterprise API](https://developers.ent.unwallet.world/ja/latest/unwallet-ent-api.html#post-metatransactions).
+- [For all developers](docs/functions-1.md)
+- [For web3 developers](docs/functions-2.md)

package/dist/types.d.ts

@@ -7,6 +7,10 @@ export interface UnWalletConfig {
     authURL: string;
     wsAPIURL: string;
 }
+export interface DigestAndSignature {
+    digest: string;
+    signature: string;
+}
 export interface MetaTransaction {
     executor: string;
     data: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/unwallet.d.ts

@@ -1,4 +1,4 @@
-import { Config, UnWalletConfig, MetaTransaction } from "./types";
+import { Config, UnWalletConfig, DigestAndSignature, MetaTransaction } from "./types";
 export declare class UnWallet {
     private config;
     private unWalletConfig;
@@ -16,7 +16,12 @@ export declare class UnWallet {
     }): void;
     sign(args: {
         message: string;
-    }): Promise<string>;
+    }): Promise<DigestAndSignature>;
+    signTransaction(args: {
+        to: string;
+        value?: string;
+        data?: string;
+    }): Promise<MetaTransaction>;
     signTokenTransfer(args: {
         id: number;
         to: string;

package/dist/unwallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unwallet.d.ts","sourceRoot":"","sources":["../src/unwallet.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAElE,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;IAiC9C,SAAS,CAAC,IAAI,EAAE;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,IAAI;IAgBD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAahD,iBAAiB,CAAC,IAAI,EAAE;QAC7B,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,eAAe,CAAC;IAerB,kBAAkB,CAAC,IAAI,EAAE;QAC9B,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBnB,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,eAAe;IAevB,OAAO,CAAC,UAAU;CAYnB"}
+{"version":3,"file":"unwallet.d.ts","sourceRoot":"","sources":["../src/unwallet.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,MAAM,EACN,cAAc,EACd,kBAAkB,EAClB,eAAe,EAChB,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;IAiC9C,SAAS,CAAC,IAAI,EAAE;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,IAAI;IAgBD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAmB5D,eAAe,CAAC,IAAI,EAAE;QAC3B,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,eAAe,CAAC;IAcrB,iBAAiB,CAAC,IAAI,EAAE;QAC7B,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,eAAe,CAAC;IAgBrB,kBAAkB,CAAC,IAAI,EAAE;QAC9B,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnB,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,eAAe;IAgCvB,OAAO,CAAC,UAAU;CAYnB"}

package/dist/unwallet.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnWallet = void 0;
+const ethers_1 = require("ethers");
 const configs_1 = require("./configs");
 class UnWallet {
     constructor(config, unWalletConfig, ws) {
@@ -35,7 +36,7 @@ class UnWallet {
             ws.onmessage = (event) => {
                 const msg = JSON.parse(event.data);
                 if (msg.type === "connectionID") {
-                    unWallet.connectionID = msg.data.value;
+                    unWallet.connectionID = msg.value;
                     resolve(unWallet);
                     return;
                 }
@@ -60,7 +61,12 @@ class UnWallet {
     }
     sign(args) {
         return new Promise((resolve, reject) => {
-            this.resolve = resolve;
+            this.resolve = (sig) => {
+                resolve({
+                    digest: ethers_1.ethers.utils.sha256(ethers_1.ethers.utils.toUtf8Bytes(args.message)),
+                    signature: sig,
+                });
+            };
             this.reject = reject;
             const url = new URL(`${this.unWalletConfig.baseURL}/x/sign`);
             url.searchParams.set("connectionID", this.connectionID);
@@ -69,6 +75,17 @@ class UnWallet {
             this.openWindow(url);
         });
     }
+    signTransaction(args) {
+        return new Promise((resolve, reject) => {
+            this.resolve = resolve;
+            this.reject = reject;
+            const url = new URL(`${this.unWalletConfig.baseURL}/x/signTransaction`);
+            url.searchParams.set("connectionID", this.connectionID);
+            url.searchParams.set("clientID", this.config.clientID);
+            url.searchParams.set("transaction", JSON.stringify(args));
+            this.openWindow(url);
+        });
+    }
     signTokenTransfer(args) {
         return new Promise((resolve, reject) => {
             this.resolve = resolve;
@@ -105,17 +122,27 @@ class UnWallet {
     handleWSMessage(msg) {
         switch (msg.type) {
             case "signature":
+                this.resolve(msg.value);
+                break;
             case "metaTransaction":
+                this.resolve(msg.value);
+                break;
             case "presentation":
-                if (msg.data.value === null) {
-                    this.reject("canceled");
-                }
-                else {
-                    this.resolve(msg.data.value);
+                this.resolve(msg.value);
+                break;
+            case "error":
+                switch (msg.value) {
+                    case "rejected":
+                        this.reject("canceled");
+                        break;
+                    default:
+                        throw new Error(msg.value);
                 }
-                this.initPromiseArgs();
                 break;
+            default:
+                throw new Error(`unknown message type: ${msg.type}`);
         }
+        this.initPromiseArgs();
     }
     openWindow(url) {
         const width = screen.width / 2;

package/docs/functions-1.md

@@ -0,0 +1,108 @@
+# Functions (for all developers)
+
+> **Note**\
+> To execute the sample codes below, you need to create an application with unWallet Enterprise in advance.
+
+## authorize
+
+`authorize` requests a user's ID token in accordance with OpenID Connect (response_type: id_token).
+
+```js
+unWallet.authorize({
+  redirectURL: "http://your.app.com/callback",
+  nonce: "pdITKAtep0pfPOrUXdzjqW6gKvXezurJ", // arbitrary string to prevent replay attacks
+});
+```
+
+## sign
+
+`sign` requests a signature for a message.
+
+```js
+const sig = await unWallet.sign({
+  message: "ARBITRARY_MESSAGE",
+});
+```
+
+### Example return value
+
+```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");
+})();
+```
+
+## signTokenTransfer
+
+`signTokenTransfer` requests a signature for a token transfer transaction.
+
+```js
+const metaTx = await unWallet.signTokenTransfer({
+  id: 101, // token ID
+  to: "0xB481148EB6A5f6b5b9Cc10cb0C8304B9B179A8e6", // destination address
+  amount: 1, // token amount
+});
+```
+
+### Example return value
+
+```json
+{
+  "executor": "0x3ADBDCBa56d70Fc15Dcbe98901432cC07B2aAaeF",
+  "data": "0x...",
+  "signature": "0x19eb83842bc2d2c55567d4da63981ae9d4ce76ec567b591f18e18f4e030c4389331ba3ce0f1549331cb51710881320982b7b7a3632a7d81ca214690ecf3267c51c"
+}
+```
+
+To execute the transaction, call [POST /metaTransactions of unWallet Enterprise API](https://developers.ent.unwallet.world/ja/latest/unwallet-ent-api.html#post-metatransactions).

package/docs/functions-2.md

@@ -0,0 +1,32 @@
+# Functions (for web3 developers)
+
+Use the following functions only if you want to work with your own contracts.
+
+> **Note**\
+> To execute the sample codes below, you need to create an application with unWallet Enterprise in advance.
+
+## signTransaction
+
+`signTransaction` requests a signature for a transaction.
+
+```js
+const metaTx = await unWallet.signTransaction({
+  to: "0xB481148EB6A5f6b5b9Cc10cb0C8304B9B179A8e6", // the address the transaction is directed to
+  value: "0x0", // the MATIC value sent with this transaction (optional)
+  data: "0x...", // the hash of the invoked method signature and encoded parameters (optional)
+});
+```
+
+:warning: You cannot specify parameters related to gas here because the gas consumed by the meta transaction is paid by the provider wallet.
+
+### Example return value
+
+```json
+{
+  "executor": "0x3ADBDCBa56d70Fc15Dcbe98901432cC07B2aAaeF",
+  "data": "0x...",
+  "signature": "0x19eb83842bc2d2c55567d4da63981ae9d4ce76ec567b591f18e18f4e030c4389331ba3ce0f1549331cb51710881320982b7b7a3632a7d81ca214690ecf3267c51c"
+}
+```
+
+To execute the transaction, call [POST /metaTransactions of unWallet Enterprise API](https://developers.ent.unwallet.world/ja/latest/unwallet-ent-api.html#post-metatransactions).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unwallet-client-sdk",
-  "version": "0.2.0",
+  "version": "0.4.1",
   "description": "unWallet client-side SDK",
   "license": "MIT",
   "author": "SIVIRA",
@@ -12,6 +12,9 @@
   "scripts": {
     "build": "tsc"
   },
+  "dependencies": {
+    "ethers": "^5.6.9"
+  },
   "devDependencies": {
     "typescript": "^4.3.4"
   }

package/src/types.ts

@@ -9,6 +9,11 @@ export interface UnWalletConfig {
   wsAPIURL: string;
 }
 
+export interface DigestAndSignature {
+  digest: string;
+  signature: string;
+}
+
 export interface MetaTransaction {
   executor: string;
   data: string;

package/src/unwallet.ts

@@ -1,5 +1,12 @@
+import { ethers } from "ethers";
+
 import { unWalletConfigs } from "./configs";
-import { Config, UnWalletConfig, MetaTransaction } from "./types";
+import {
+  Config,
+  UnWalletConfig,
+  DigestAndSignature,
+  MetaTransaction,
+} from "./types";
 
 export class UnWallet {
   private config: Config;
@@ -47,7 +54,7 @@ export class UnWallet {
       ws.onmessage = (event) => {
         const msg = JSON.parse(event.data);
         if (msg.type === "connectionID") {
-          unWallet.connectionID = msg.data.value;
+          unWallet.connectionID = msg.value;
           resolve(unWallet);
           return;
         }
@@ -79,15 +86,39 @@ export class UnWallet {
     location.assign(url.toString());
   }
 
-  public sign(args: { message: string }): Promise<string> {
+  public sign(args: { message: string }): Promise<DigestAndSignature> {
     return new Promise((resolve, reject) => {
-      this.resolve = resolve;
+      this.resolve = (sig: string) => {
+        resolve({
+          digest: ethers.utils.sha256(ethers.utils.toUtf8Bytes(args.message)),
+          signature: sig,
+        });
+      };
       this.reject = reject;
 
       const url = new URL(`${this.unWalletConfig.baseURL}/x/sign`);
       url.searchParams.set("connectionID", this.connectionID);
       url.searchParams.set("clientID", this.config.clientID);
       url.searchParams.set("message", args.message);
+
+      this.openWindow(url);
+    });
+  }
+
+  public signTransaction(args: {
+    to: string;
+    value?: string;
+    data?: string;
+  }): Promise<MetaTransaction> {
+    return new Promise((resolve, reject) => {
+      this.resolve = resolve;
+      this.reject = reject;
+
+      const url = new URL(`${this.unWalletConfig.baseURL}/x/signTransaction`);
+      url.searchParams.set("connectionID", this.connectionID);
+      url.searchParams.set("clientID", this.config.clientID);
+      url.searchParams.set("transaction", JSON.stringify(args));
+
       this.openWindow(url);
     });
   }
@@ -107,6 +138,7 @@ export class UnWallet {
       url.searchParams.set("id", args.id.toString());
       url.searchParams.set("to", args.to);
       url.searchParams.set("amount", args.amount.toString());
+
       this.openWindow(url);
     });
   }
@@ -126,6 +158,7 @@ export class UnWallet {
       url.searchParams.set("clientID", this.config.clientID);
       url.searchParams.set("credential", args.credential);
       url.searchParams.set("challenge", args.challenge);
+
       this.openWindow(url);
     });
   }
@@ -143,16 +176,33 @@ export class UnWallet {
   private handleWSMessage(msg: any): void {
     switch (msg.type) {
       case "signature":
+        this.resolve!(msg.value);
+        break;
+
       case "metaTransaction":
+        this.resolve!(msg.value);
+        break;
+
       case "presentation":
-        if (msg.data.value === null) {
-          this.reject!("canceled");
-        } else {
-          this.resolve!(msg.data.value);
+        this.resolve!(msg.value);
+        break;
+
+      case "error":
+        switch (msg.value) {
+          case "rejected":
+            this.reject!("canceled");
+            break;
+
+          default:
+            throw new Error(msg.value);
         }
-        this.initPromiseArgs();
         break;
+
+      default:
+        throw new Error(`unknown message type: ${msg.type}`);
     }
+
+    this.initPromiseArgs();
   }
 
   private openWindow(url: URL): void {