unwallet-client-sdk 0.9.0 → 0.10.0

package/.github/workflows/publish.yml

@@ -3,7 +3,7 @@ on:
   release:
     types: [published]
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

package/README.md

@@ -1,6 +1,6 @@
 # unWallet client-side SDK
 
-:warning: This SDK works fine only on browsers.
+:warning: This SDK works correctly only on web browsers.
 
 ## Installation
 
@@ -18,7 +18,6 @@ const unWallet = await UnWallet.init({
 });
 ```
 
-## Functions
+## Usage
 
-- [For all developers](docs/functions-1.md)
-- [For web3 developers](docs/functions-2.md)
+See [Functions](docs/functions.md).

package/dist/configs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"configs.d.ts","sourceRoot":"","sources":["../src/configs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,eAAe,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAa5D,CAAC"}
+{"version":3,"file":"configs.d.ts","sourceRoot":"","sources":["../src/configs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,eAAO,MAAM,eAAe,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAS5D,CAAC"}

package/dist/configs.js

@@ -7,10 +7,6 @@ exports.unWalletConfigs = {
         wsAPIURL: "wss://in-ws-api.id.unwallet.world",
     },
     dev: {
-        baseURL: "https://id.unwallet.dev",
-        wsAPIURL: "wss://in-ws-api.id.unwallet.dev",
-    },
-    local: {
         baseURL: "http://localhost:4200",
         wsAPIURL: "wss://in-ws-api.id.test.unwallet.dev",
     },

package/dist/types.d.ts

@@ -6,13 +6,11 @@ export interface UnWalletConfig {
     baseURL: string;
     wsAPIURL: string;
 }
-export interface DigestAndSignature {
+export interface SignResult {
     digest: string;
     signature: string;
 }
-export interface MetaTransaction {
-    executor: string;
-    data: string;
-    signature: string;
+export interface SendTransactionResult {
+    TransactionID: string;
 }
 //# sourceMappingURL=types.d.ts.map

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,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"}
+{"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,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;CACvB"}

package/dist/unwallet.d.ts

@@ -1,4 +1,4 @@
-import { Config, UnWalletConfig, DigestAndSignature, MetaTransaction } from "./types";
+import { Config, UnWalletConfig, SignResult, SendTransactionResult } from "./types";
 export declare class UnWallet {
     private config;
     private unWalletConfig;
@@ -18,17 +18,14 @@ export declare class UnWallet {
     }): void;
     sign(args: {
         message: string;
-    }): Promise<DigestAndSignature>;
-    signTransaction(args: {
-        to: string;
+    }): Promise<SignResult>;
+    sendTransaction(args: {
+        chainID: number;
+        toAddress: string;
         value?: string;
         data?: string;
-    }): Promise<MetaTransaction>;
-    signTokenTransfer(args: {
-        id: number;
-        to: string;
-        amount: number;
-    }): Promise<MetaTransaction>;
+        ticket: string;
+    }): Promise<SendTransactionResult>;
     private getConnectionID;
     private sendWSMessage;
     private handleWSMessage;

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,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;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;IAyBD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsB5D,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;IAiBrB,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;IAkB5B,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;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;IAgClC,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,eAAe;IA4BvB,OAAO,CAAC,UAAU;CAYnB"}

package/dist/unwallet.js

@@ -52,7 +52,7 @@ class UnWallet {
         if (!args.responseMode) {
             args.responseMode = "fragment";
         }
-        let url = new URL(`${this.unWalletConfig.baseURL}/${args.isVirtual ? "v" : ""}authorize`);
+        let url = new URL(`${this.unWalletConfig.baseURL}/${args.isVirtual === false ? "" : "v"}authorize`);
         {
             url.searchParams.set("response_type", "id_token");
             url.searchParams.set("response_mode", args.responseMode);
@@ -86,32 +86,24 @@ class UnWallet {
             this.openWindow(url);
         });
     }
-    // DEPRECATED
-    signTransaction(args) {
+    sendTransaction(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));
+            if (args.value === undefined && args.data === undefined) {
+                throw new Error("either value or data required");
             }
-            this.openWindow(url);
-        });
-    }
-    // DEPRECATED
-    signTokenTransfer(args) {
-        return new Promise((resolve, reject) => {
-            this.resolve = resolve;
+            this.resolve = (txID) => {
+                resolve({ TransactionID: txID });
+            };
             this.reject = reject;
-            const url = new URL(`${this.unWalletConfig.baseURL}/x/signTokenTransfer`);
+            const url = new URL(`${this.unWalletConfig.baseURL}/x/sendTransaction`);
             {
                 url.searchParams.set("connectionID", this.connectionID);
                 url.searchParams.set("clientID", this.config.clientID);
-                url.searchParams.set("id", args.id.toString());
-                url.searchParams.set("to", args.to);
-                url.searchParams.set("amount", args.amount.toString());
+                url.searchParams.set("chainID", args.chainID.toString());
+                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);
             }
             this.openWindow(url);
         });

package/docs/{functions-1.md → functions.md}

@@ -1,16 +1,18 @@
-# Functions (for all developers)
+# Functions
 
 > **Note**\
-> To execute the sample codes below, you need to create an application with unWallet Enterprise in advance.
+> 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: "pdITKAtep0pfPOrUXdzjqW6gKvXezurJ", // arbitrary string to prevent replay attacks
+  nonce: "ARBITRARY_STRING_TO_PREVENT_REPLAY_ATTACKS",
 });
 ```
 
@@ -18,13 +20,15 @@ unWallet.authorize({
 
 `sign` requests a signature for a message.
 
+### Example call
+
 ```js
-const sig = await unWallet.sign({
+const result = await unWallet.sign({
   message: "ARBITRARY_MESSAGE",
 });
 ```
 
-### Example return value
+### Example result
 
 ```json
 {
@@ -83,26 +87,32 @@ const ethers = require("ethers");
 })();
 ```
 
-## signTokenTransfer
+## sendTransaction
+
+`sendTransaction` requests to send a transaction.
 
-`signTokenTransfer` requests a signature for a token transfer transaction.
+### Example call
+
+> **Note**\
+> You need to issue a transaction ticket via unWallet Enterprise API in advance.
 
 ```js
-const metaTx = await unWallet.signTokenTransfer({
-  id: 101, // token ID
-  to: "0xB481148EB6A5f6b5b9Cc10cb0C8304B9B179A8e6", // destination address
-  amount: 1, // token amount
+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 return value
+### Example result
 
 ```json
 {
-  "executor": "0x3ADBDCBa56d70Fc15Dcbe98901432cC07B2aAaeF",
-  "data": "0x...",
-  "signature": "0x19eb83842bc2d2c55567d4da63981ae9d4ce76ec567b591f18e18f4e030c4389331ba3ce0f1549331cb51710881320982b7b7a3632a7d81ca214690ecf3267c51c"
+  "transactionID": "UXVldWVkVHJhbnNhY3Rpb246MQ=="
 }
 ```
 
-To execute the transaction, call [POST /metaTransactions of unWallet Enterprise API](https://developers.ent.unwallet.world/ja/latest/unwallet-ent-api.html#post-metatransactions).
+> **Note**\
+> You can get the transaction detail via unWallet Enterprise API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unwallet-client-sdk",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "unWallet client-side SDK",
   "license": "MIT",
   "author": "SIVIRA",
@@ -15,7 +15,7 @@
     }
   },
   "dependencies": {
-    "ethers": "6.12.0"
+    "ethers": "6.13.1"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
@@ -23,7 +23,7 @@
     "commitizen": "4.3.0",
     "cz-conventional-changelog": "3.3.0",
     "husky": "9.0.11",
-    "typescript": "5.4.5"
+    "typescript": "5.5.2"
   },
   "scripts": {
     "build": "tsc",

package/src/configs.ts

@@ -6,10 +6,6 @@ export const unWalletConfigs: { [env: string]: UnWalletConfig } = {
     wsAPIURL: "wss://in-ws-api.id.unwallet.world",
   },
   dev: {
-    baseURL: "https://id.unwallet.dev",
-    wsAPIURL: "wss://in-ws-api.id.unwallet.dev",
-  },
-  local: {
     baseURL: "http://localhost:4200",
     wsAPIURL: "wss://in-ws-api.id.test.unwallet.dev",
   },

package/src/types.ts

@@ -8,13 +8,11 @@ export interface UnWalletConfig {
   wsAPIURL: string;
 }
 
-export interface DigestAndSignature {
+export interface SignResult {
   digest: string;
   signature: string;
 }
 
-export interface MetaTransaction {
-  executor: string;
-  data: string;
-  signature: string;
+export interface SendTransactionResult {
+  TransactionID: string;
 }

package/src/unwallet.ts

@@ -4,8 +4,8 @@ import { unWalletConfigs } from "./configs";
 import {
   Config,
   UnWalletConfig,
-  DigestAndSignature,
-  MetaTransaction,
+  SignResult,
+  SendTransactionResult,
 } from "./types";
 
 export class UnWallet {
@@ -83,7 +83,9 @@ export class UnWallet {
     }
 
     let url = new URL(
-      `${this.unWalletConfig.baseURL}/${args.isVirtual ? "v" : ""}authorize`
+      `${this.unWalletConfig.baseURL}/${
+        args.isVirtual === false ? "" : "v"
+      }authorize`
     );
     {
       url.searchParams.set("response_type", "id_token");
@@ -102,7 +104,7 @@ export class UnWallet {
     location.assign(url.toString());
   }
 
-  public sign(args: { message: string }): Promise<DigestAndSignature> {
+  public sign(args: { message: string }): Promise<SignResult> {
     return new Promise((resolve, reject) => {
       this.resolve = (sig: string) => {
         resolve({
@@ -123,44 +125,38 @@ export class UnWallet {
     });
   }
 
-  // DEPRECATED
-  public signTransaction(args: {
-    to: string;
+  public sendTransaction(args: {
+    chainID: number;
+    toAddress: string;
     value?: string;
     data?: string;
-  }): Promise<MetaTransaction> {
+    ticket: string;
+  }): Promise<SendTransactionResult> {
     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));
+      if (args.value === undefined && args.data === undefined) {
+        throw new Error("either value or data required");
       }
 
-      this.openWindow(url);
-    });
-  }
-
-  // DEPRECATED
-  public signTokenTransfer(args: {
-    id: number;
-    to: string;
-    amount: number;
-  }): Promise<MetaTransaction> {
-    return new Promise((resolve, reject) => {
-      this.resolve = resolve;
+      this.resolve = (txID: string) => {
+        resolve({ TransactionID: txID });
+      };
       this.reject = reject;
 
-      const url = new URL(`${this.unWalletConfig.baseURL}/x/signTokenTransfer`);
+      const url = new URL(`${this.unWalletConfig.baseURL}/x/sendTransaction`);
       {
         url.searchParams.set("connectionID", this.connectionID);
         url.searchParams.set("clientID", this.config.clientID);
-        url.searchParams.set("id", args.id.toString());
-        url.searchParams.set("to", args.to);
-        url.searchParams.set("amount", args.amount.toString());
+        url.searchParams.set("chainID", args.chainID.toString());
+        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);
       }
 
       this.openWindow(url);

package/docs/functions-2.md

@@ -1,32 +0,0 @@
-# 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).