@mysten/wallet-standard 0.5.14 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @mysten/wallet-standard
 
+## 0.6.0
+
+### Minor Changes
+
+- 8281e3d25: Deprecate `signMessage` method, and introduce the new `signPersonalMessage` method.
+
+### Patch Changes
+
+- Updated dependencies [a503cad34]
+- Updated dependencies [8281e3d25]
+  - @mysten/sui.js@0.40.0
+
 ## 0.5.14
 
 ### Patch Changes

package/README.md

@@ -3,152 +3,4 @@
 A suite of standard utilities for implementing wallets and libraries based on the
 [Wallet Standard](https://github.com/wallet-standard/wallet-standard/).
 
-## Implementing the Wallet Standard in an extension wallet
-
-### Creating a wallet interface
-
-You need to create a class that represents your wallet. You can use the `Wallet` interface from
-`@mysten/wallet-standard` to help ensure your class adheres to the standard.
-
-```typescript
-import { Wallet, SUI_DEVNET_CHAIN } from '@mysten/wallet-standard';
-
-class YourWallet implements Wallet {
-	get version() {
-		// Return the version of the Wallet Standard this implements (in this case, 1.0.0).
-		return '1.0.0';
-	}
-	get name() {
-		return 'Wallet Name';
-	}
-	get icon() {
-		return 'some-icon-data-url';
-	}
-
-	// Return the Sui chains that your wallet supports.
-	get chains() {
-		return [SUI_DEVNET_CHAIN];
-	}
-}
-```
-
-### Implementing features
-
-Features are standard methods consumers can use to interact with a wallet. To be listed in the Sui
-wallet adapter, you must implement the following features in your wallet:
-
-- `standard:connect` - Used to initiate a connection to the wallet.
-- `standard:events` - Used to listen for changes that happen within the wallet, such as accounts
-  being added or removed.
-- `sui:signTransactionBlock` - Used to prompt the user to sign a transaction block, and return the
-  serializated transaction block and signature back to the user. This method does not submit the
-  transaction block for execution.
-- `sui:signAndExecuteTransactionBlock` - Used to prompt the user to sign a transaction block, then
-  submit it for execution to the blockchain.
-
-You can implement these features in your wallet class under the `features` property:
-
-```typescript
-import {
-  StandardConnectFeature,
-  StandardConnectMethod,
-  StandardEventsFeature,
-  StandardEventsOnMethod,
-  SuiFeatures,
-  SuiSignTransactionBlockMethod,
-  SuiSignAndExecuteTransactionBlockMethod
-} from "@mysten/wallet-standard";
-
-class YourWallet implements Wallet {
-  get features(): StandardConnectFeature & StandardEventsFeature & SuiFeatures {
-    return {
-      "standard:connect": {
-        version: "1.0.0",
-        connect: this.#connect,
-      },
-      "standard:events": {
-        version: "1.0.0",
-        on: this.#on,
-      },
-      "sui:signTransactionBlock": {
-        version: "1.0.0",
-        signTransactionBlock: this.#signTransactionBlock,
-      },
-      "sui:signAndExecuteTransactionBlock": {
-        version: "1.1.0",
-        signAndExecuteTransactionBlock: this.#signAndExecuteTransactionBlock,
-      },
-      'sui:signMessage': {
-        version: '1.0.0',
-        signMessage: this.#signMessage,
-      },
-    };
-  },
-
-  #on: StandardEventsOnMethod = () => {
-    // Your wallet's on implementation.
-  };
-
-  #connect: StandardConnectMethod = () => {
-    // Your wallet's implementation
-  };
-
-  #signTransactionBlock: SuiSignTransactionBlockMethod = () => {
-    // Your wallet's implementation
-  };
-
-  #signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod = () => {
-    // Your wallet's implementation
-  };
-
-  #signMessage: SuiSignMessageMethod = () => {
-    // Your wallet's implementation
-  };
-}
-```
-
-### Exposing accounts
-
-The last requirement of the wallet interface is to expose an `acccounts` interface. This should
-expose all of the accounts that a connected dapp has access to. It can be empty prior to initiating
-a connection through the `standard:connect` feature.
-
-The accounts can use the `ReadonlyWalletAccount` class to easily construct an account matching the
-required interface.
-
-```typescript
-import { ReadonlyWalletAccount } from '@mysten/wallet-standard';
-
-class YourWallet implements Wallet {
-	get accounts() {
-		// Assuming we already have some internal representation of accounts:
-		return someWalletAccounts.map(
-			(walletAccount) =>
-				// Return
-				new ReadonlyWalletAccount({
-					address: walletAccount.suiAddress,
-					publicKey: walletAccount.pubkey,
-					// The Sui chains that your wallet supports.
-					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:signAndExecuteTransactionBlock'],
-				}),
-		);
-	}
-}
-```
-
-### Registering in the window
-
-Once you have a compatible interface for your wallet, you can register it using the `registerWallet`
-function.
-
-```typescript
-import { registerWallet } from '@mysten/wallet-standard';
-
-registerWallet(new YourWallet());
-```
-
-> 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).
+**Documentation:** https://sui-wallet-kit.vercel.app/advanced/wallet-standard

package/dist/features/index.d.ts

@@ -2,11 +2,13 @@ import type { WalletWithFeatures } from '@wallet-standard/core';
 import type { SuiSignTransactionBlockFeature } from './suiSignTransactionBlock';
 import type { SuiSignAndExecuteTransactionBlockFeature } from './suiSignAndExecuteTransactionBlock';
 import { SuiSignMessageFeature } from './suiSignMessage';
+import { SuiSignPersonalMessageFeature } from './suiSignPersonalMessage';
 /**
  * Wallet Standard features that are unique to Sui, and that all Sui wallets are expected to implement.
  */
-export type SuiFeatures = SuiSignTransactionBlockFeature & SuiSignAndExecuteTransactionBlockFeature & SuiSignMessageFeature;
+export type SuiFeatures = SuiSignTransactionBlockFeature & SuiSignAndExecuteTransactionBlockFeature & SuiSignPersonalMessageFeature & Partial<SuiSignMessageFeature>;
 export type WalletWithSuiFeatures = WalletWithFeatures<SuiFeatures>;
 export * from './suiSignMessage';
 export * from './suiSignTransactionBlock';
 export * from './suiSignAndExecuteTransactionBlock';
+export * from './suiSignPersonalMessage';

package/dist/features/suiSignMessage.d.ts

@@ -1,10 +1,14 @@
-import type { SignedMessage } from '@mysten/sui.js';
 import type { WalletAccount } from '@wallet-standard/core';
-/** The latest API version of the signMessage API. */
+/**
+ * The latest API version of the signMessage API.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
 export type SuiSignMessageVersion = '1.0.0';
 /**
  * A Wallet Standard feature for signing a personal message, and returning the
  * message bytes that were signed, and message signature.
+ *
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
  */
 export type SuiSignMessageFeature = {
     /** Namespace for the feature. */
@@ -14,12 +18,21 @@ export type SuiSignMessageFeature = {
         signMessage: SuiSignMessageMethod;
     };
 };
+/** @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature */
 export type SuiSignMessageMethod = (input: SuiSignMessageInput) => Promise<SuiSignMessageOutput>;
-/** Input for signing messages. */
+/**
+ * Input for signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
 export interface SuiSignMessageInput {
     message: Uint8Array;
     account: WalletAccount;
 }
-/** Output of signing messages. */
-export interface SuiSignMessageOutput extends SignedMessage {
+/**
+ * Output of signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
+export interface SuiSignMessageOutput {
+    messageBytes: string;
+    signature: string;
 }

package/dist/features/suiSignPersonalMessage.d.ts

@@ -0,0 +1,26 @@
+import type { WalletAccount } from '@wallet-standard/core';
+/** The latest API version of the signPersonalMessage API. */
+export type SuiSignPersonalMessageVersion = '1.0.0';
+/**
+ * A Wallet Standard feature for signing a personal message, and returning the
+ * message bytes that were signed, and message signature.
+ */
+export type SuiSignPersonalMessageFeature = {
+    /** Namespace for the feature. */
+    'sui:signPersonalMessage': {
+        /** Version of the feature API. */
+        version: SuiSignPersonalMessageVersion;
+        signPersonalMessage: SuiSignPersonalMessageMethod;
+    };
+};
+export type SuiSignPersonalMessageMethod = (input: SuiSignPersonalMessageInput) => Promise<SuiSignPersonalMessageOutput>;
+/** Input for signing personal messages. */
+export interface SuiSignPersonalMessageInput {
+    message: Uint8Array;
+    account: WalletAccount;
+}
+/** Output of signing personal messages. */
+export interface SuiSignPersonalMessageOutput {
+    bytes: string;
+    signature: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten/wallet-standard",
-  "version": "0.5.14",
+  "version": "0.6.0",
   "description": "A suite of standard utilities for implementing wallets based on the Wallet Standard.",
   "license": "Apache-2.0",
   "author": "Mysten Labs <build@mystenlabs.com>",
@@ -22,7 +22,7 @@
   ],
   "dependencies": {
     "@wallet-standard/core": "1.0.3",
-    "@mysten/sui.js": "0.39.0"
+    "@mysten/sui.js": "0.40.0"
   },
   "devDependencies": {
     "tsup": "^7.1.0",

package/src/features/index.ts

@@ -5,16 +5,20 @@ import type { WalletWithFeatures } from '@wallet-standard/core';
 import type { SuiSignTransactionBlockFeature } from './suiSignTransactionBlock';
 import type { SuiSignAndExecuteTransactionBlockFeature } from './suiSignAndExecuteTransactionBlock';
 import { SuiSignMessageFeature } from './suiSignMessage';
+import { SuiSignPersonalMessageFeature } from './suiSignPersonalMessage';
 
 /**
  * Wallet Standard features that are unique to Sui, and that all Sui wallets are expected to implement.
  */
 export type SuiFeatures = SuiSignTransactionBlockFeature &
 	SuiSignAndExecuteTransactionBlockFeature &
-	SuiSignMessageFeature;
+	SuiSignPersonalMessageFeature &
+	// This deprecated feature should be removed once wallets update to the new method:
+	Partial<SuiSignMessageFeature>;
 
 export type WalletWithSuiFeatures = WalletWithFeatures<SuiFeatures>;
 
 export * from './suiSignMessage';
 export * from './suiSignTransactionBlock';
 export * from './suiSignAndExecuteTransactionBlock';
+export * from './suiSignPersonalMessage';

package/src/features/suiSignMessage.ts

@@ -1,15 +1,19 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { SignedMessage } from '@mysten/sui.js';
 import type { WalletAccount } from '@wallet-standard/core';
 
-/** The latest API version of the signMessage API. */
+/**
+ * The latest API version of the signMessage API.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
 export type SuiSignMessageVersion = '1.0.0';
 
 /**
  * A Wallet Standard feature for signing a personal message, and returning the
  * message bytes that were signed, and message signature.
+ *
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
  */
 export type SuiSignMessageFeature = {
 	/** Namespace for the feature. */
@@ -20,13 +24,23 @@ export type SuiSignMessageFeature = {
 	};
 };
 
+/** @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature */
 export type SuiSignMessageMethod = (input: SuiSignMessageInput) => Promise<SuiSignMessageOutput>;
 
-/** Input for signing messages. */
+/**
+ * Input for signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
 export interface SuiSignMessageInput {
 	message: Uint8Array;
 	account: WalletAccount;
 }
 
-/** Output of signing messages. */
-export interface SuiSignMessageOutput extends SignedMessage {}
+/**
+ * Output of signing messages.
+ * @deprecated Wallets can still implement this method for compatibility, but this has been replaced by the `sui:signPersonalMessage` feature
+ */
+export interface SuiSignMessageOutput {
+	messageBytes: string;
+	signature: string;
+}

package/src/features/suiSignPersonalMessage.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { WalletAccount } from '@wallet-standard/core';
+
+/** The latest API version of the signPersonalMessage API. */
+export type SuiSignPersonalMessageVersion = '1.0.0';
+
+/**
+ * A Wallet Standard feature for signing a personal message, and returning the
+ * message bytes that were signed, and message signature.
+ */
+export type SuiSignPersonalMessageFeature = {
+	/** Namespace for the feature. */
+	'sui:signPersonalMessage': {
+		/** Version of the feature API. */
+		version: SuiSignPersonalMessageVersion;
+		signPersonalMessage: SuiSignPersonalMessageMethod;
+	};
+};
+
+export type SuiSignPersonalMessageMethod = (
+	input: SuiSignPersonalMessageInput,
+) => Promise<SuiSignPersonalMessageOutput>;
+
+/** Input for signing personal messages. */
+export interface SuiSignPersonalMessageInput {
+	message: Uint8Array;
+	account: WalletAccount;
+}
+
+/** Output of signing personal messages. */
+export interface SuiSignPersonalMessageOutput {
+	bytes: string;
+	signature: string;
+}