[wallet-ext][wallet-adapter] Update to new wallet standard (MystenLab…

…s#5585)
0xdigiscore · Oct 27, 2022 · 56de844 · 56de844
1 parent 73074c9
commit 56de844
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 59 deletions.
diff --git a/.changeset/poor-pandas-hunt.md b/.changeset/poor-pandas-hunt.md
@@ -0,0 +1,6 @@
+---
+"@mysten/wallet-adapter-wallet-standard": minor
+"@mysten/wallet-standard": minor
+---
+
+Update wallet standard adapters to use new wallet registration logic.
diff --git a/apps/wallet/src/dapp-interface/WalletStandardInterface.ts b/apps/wallet/src/dapp-interface/WalletStandardInterface.ts
@@ -122,10 +122,7 @@ export class SuiWallet implements Wallet {
                     // TODO: Expose public key instead of address:
                     publicKey: new Uint8Array(),
                     chains: SUI_CHAINS,
-                    features: [
-                        'sui:signAndExecuteTransaction',
-                        'standard:signMessage',
-                    ],
+                    features: ['sui:signAndExecuteTransaction'],
                 });
                 this.#events.emit('change', { accounts: this.accounts });
             }

diff --git a/apps/wallet/src/dapp-interface/index.ts b/apps/wallet/src/dapp-interface/index.ts
@@ -1,17 +1,12 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { registerWallet } from '@mysten/wallet-standard';
+
 import { DAppInterface } from './DAppInterface';
 import { SuiWallet } from './WalletStandardInterface';
 
-import type { WalletsWindow } from '@mysten/wallet-standard';
-
-declare const window: WalletsWindow;
-
-window.navigator.wallets = window.navigator.wallets || [];
-window.navigator.wallets.push(({ register }) => {
-    register(new SuiWallet());
-});
+registerWallet(new SuiWallet());
 
 Object.defineProperty(window, 'suiWallet', {
     enumerable: false,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/sdk/wallet-adapter/packages/adapters/wallet-standard-adapter/package.json b/sdk/wallet-adapter/packages/adapters/wallet-standard-adapter/package.json
@@ -29,7 +29,6 @@
     "@mysten/sui.js": "workspace:*",
     "@mysten/wallet-adapter-base": "workspace:*",
     "@mysten/wallet-standard": "workspace:*",
-    "@wallet-standard/app": "0.1.0-alpha.6",
     "mitt": "^3.0.0"
   },
   "devDependencies": {

diff --git a/sdk/wallet-adapter/packages/adapters/wallet-standard-adapter/src/index.ts b/sdk/wallet-adapter/packages/adapters/wallet-standard-adapter/src/index.ts
@@ -5,8 +5,9 @@ import { WalletAdapterProvider } from "@mysten/wallet-adapter-base";
 import {
   isStandardWalletAdapterCompatibleWallet,
   StandardWalletAdapterWallet,
+  DEPRECATED_getWallets,
+  Wallets,
 } from "@mysten/wallet-standard";
-import { initialize, InitializedWallets } from "@wallet-standard/app";
 import { StandardWalletAdapter } from "./StandardWalletAdapter";
 import mitt, { Emitter } from "mitt";
 
@@ -15,13 +16,13 @@ type Events = {
 };
 
 export class WalletStandardAdapterProvider implements WalletAdapterProvider {
-  #wallets: InitializedWallets;
+  #wallets: Wallets;
   #adapters: Map<StandardWalletAdapterWallet, StandardWalletAdapter>;
   #events: Emitter<Events>;
 
   constructor() {
     this.#adapters = new Map();
-    this.#wallets = initialize();
+    this.#wallets = DEPRECATED_getWallets();
     this.#events = mitt();
 
     this.#wallets.on("register", () => {

diff --git a/sdk/wallet-adapter/packages/wallet-standard/README.md b/sdk/wallet-adapter/packages/wallet-standard/README.md
@@ -72,13 +72,13 @@ class YourWallet implements Wallet {
     // Your wallet's events on implementation.
   };
 
-	#connect: ConnectMethod = () => {
-		// Your wallet's connect implementation
-	};
+  #connect: ConnectMethod = () => {
+    // Your wallet's connect implementation
+  };
 
-	#signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = () => {
-		// Your wallet's signAndExecuteTransaction implementation
-	};
+  #signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = () => {
+    // Your wallet's signAndExecuteTransaction implementation
+  };
 }
 ```
 
@@ -104,7 +104,7 @@ class YourWallet implements Wallet {
           chains: [SUI_DEVNET_CHAIN],
           // The features that this account supports. This can be a subset of the wallet's supported features.
           // These features must exist on the wallet as well.
-          features: ["sui:signAndExecuteTransaction", "standard:signMessage"],
+          features: ["sui:signAndExecuteTransaction"],
         })
     );
   }
@@ -113,15 +113,12 @@ class YourWallet implements Wallet {
 
 ### Registering in the window
 
-Once you have a compatible interface for your wallet, you can register it in the window under the `window.navigator.wallets` interface. Wallets self-register by pushing their standard wallet interface to this array-like interface.
+Once you have a compatible interface for your wallet, you can register it using the `registerWallet` function.
 
 ```typescript
-// This makes TypeScript aware of the `window.navigator.wallets` interface.
-declare const window: import("@mysten/wallet-standard").WalletsWindow;
+import { registerWallet } from '@mysten/wallet-standard';
 
-(window.navigator.wallets || []).push(({ register }) => {
-  register(new YourWallet());
-});
+registerWallet(new YourWallet());
 ```
 
-> Note that while this interface is array-like, it is not always an array, and the only method that should be called on it is `push`.
+> If you're interested in the internal implementation of the `registerWallet` method, you can [see how it works here](https://github.com/wallet-standard/wallet-standard/blob/b4794e761de688906827829d5380b24cb8ed5fd5/packages/core/wallet/src/register.ts#L9).
diff --git a/sdk/wallet-adapter/packages/wallet-standard/package.json b/sdk/wallet-adapter/packages/wallet-standard/package.json
@@ -27,9 +27,7 @@
   },
   "dependencies": {
     "@mysten/sui.js": "workspace:*",
-    "@wallet-standard/features": "0.1.0-alpha.4",
-    "@wallet-standard/standard": "0.1.0-alpha.5",
-    "@wallet-standard/util": "0.1.0-alpha.6"
+    "@wallet-standard/core": "1.0.0-rc.5"
   },
   "devDependencies": {
     "tsup": "^6.2.2",

diff --git a/sdk/wallet-adapter/packages/wallet-standard/src/detect.ts b/sdk/wallet-adapter/packages/wallet-standard/src/detect.ts
@@ -5,8 +5,9 @@ import {
   ConnectFeature,
   DisconnectFeature,
   EventsFeature,
-} from "@wallet-standard/features";
-import { Wallet, WalletWithFeatures } from "@wallet-standard/standard";
+  Wallet,
+  WalletWithFeatures,
+} from "@wallet-standard/core";
 import { SuiSignAndExecuteTransactionFeature } from "./features";
 
 export type StandardWalletAdapterWallet = WalletWithFeatures<

diff --git a/sdk/wallet-adapter/packages/wallet-standard/src/features/index.ts b/sdk/wallet-adapter/packages/wallet-standard/src/features/index.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { WalletWithFeatures } from "@wallet-standard/standard";
+import type { WalletWithFeatures } from "@wallet-standard/core";
 import type { SuiSignAndExecuteTransactionFeature } from "./suiSignAndExecuteTransaction";
 
 /**

diff --git a/sdk/wallet-adapter/packages/wallet-standard/src/features/suiSignAndExecuteTransaction.ts b/sdk/wallet-adapter/packages/wallet-standard/src/features/suiSignAndExecuteTransaction.ts
@@ -5,7 +5,7 @@ import type {
   SignableTransaction,
   SuiTransactionResponse,
 } from "@mysten/sui.js";
-import type { SignAndSendTransactionInput } from "@wallet-standard/features";
+import type { SignAndSendTransactionInput } from "@wallet-standard/core";
 
 /** The latest API version of the signAndExecuteTransaction API. */
 export type SuiSignAndExecuteTransactionVersion = "1.0.0";

diff --git a/sdk/wallet-adapter/packages/wallet-standard/src/index.ts b/sdk/wallet-adapter/packages/wallet-standard/src/index.ts
@@ -1,9 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-export * from '@wallet-standard/standard';
-export * from '@wallet-standard/features';
-export * from '@wallet-standard/util';
+export * from '@wallet-standard/core';
 
 export * from "./features";
 export * from "./detect";