@mysten/wallet-standard 0.4.3 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,99 @@
 # @mysten/wallet-standard
 
+## 0.5.1
+
+### Patch Changes
+
+- Updated dependencies [976d3e1fe]
+- Updated dependencies [0419b7c53]
+- Updated dependencies [f3c096e3a]
+- Updated dependencies [5a4e3e416]
+- Updated dependencies [27dec39eb]
+  - @mysten/sui.js@0.31.0
+
+## 0.5.0
+
+### Minor Changes
+
+- 956ec28eb: Change `signMessage` to return message bytes. Add support for sui:signMessage in the wallet standard
+- 19b567f21: Unified self- and delegated staking flows. Removed fields from `Validator` (`stake_amount`, `pending_stake`, and `pending_withdraw`) and renamed `delegation_staking_pool` to `staking_pool`. Additionally removed the `validator_stake` and `delegated_stake` fields in the `ValidatorSet` type and replaced them with a `total_stake` field.
+- 5c3b00cde: Add object id to staking pool and pool id to staked sui.
+- 3d9a04648: Adds `deactivation_epoch` to staking pool object, and adds `inactive_pools` to the validator set object.
+- da72e73a9: Change the address of Move package for staking and validator related Move modules.
+- 0672b5990: The Wallet Standard now only supports the `Transaction` type, instead of the previous `SignableTransaction` type.
+- 0a7b42a6d: This changes almost all occurences of "delegate", "delegation" (and various capitalizations/forms) to their equivalent "stake"-based name. Function names, function argument names, RPC endpoints, Move functions, and object fields have been updated with this new naming convention.
+- c718deef4: wallet-standard: changes sui:signAndExecuteTransaction and sui:signTransaction features to support account and chain options
+  wallet-adapter-wallet-standard: change signAndExecuteTransaction and signTransaction signatures to support account and chain options
+  wallet-adapter-wallet-standard: ensure version compatibility for of the wallet signAndExecuteTransaction and signTransaction features before using them (same major version)
+  wallet-kit-core/wallet-kit: expose accounts as ReadonlyWalletAccount instead of only the address
+  wallet-kit-core: signTransaction and signAndExecuteTransaction methods mirror the ones in standard adapter
+- 68e60b02c: Changed where the options and requestType for signAndExecuteTransaction are.
+- dbe73d5a4: Add an optional `contentOptions` field to `SuiSignAndExecuteTransactionOptions` to specify which fields to include in `SuiTransactionBlockResponse` (e.g., transaction, effects, events, etc). By default, only the transaction digest will be included.
+
+### Patch Changes
+
+- bf545c7d0: Add `features` prop to wallet kit that allows dapps to define which features they require to function properly.
+- Updated dependencies [956ec28eb]
+- Updated dependencies [4adfbff73]
+- Updated dependencies [4c4573ebe]
+- Updated dependencies [acc2edb31]
+- Updated dependencies [941b03af1]
+- Updated dependencies [a6690ac7d]
+- Updated dependencies [a211dc03a]
+- Updated dependencies [4c1e331b8]
+- Updated dependencies [19b567f21]
+- Updated dependencies [7659e2e91]
+- Updated dependencies [0d3cb44d9]
+- Updated dependencies [00bb9bb66]
+- Updated dependencies [36c264ebb]
+- Updated dependencies [891abf5ed]
+- Updated dependencies [2e0ef59fa]
+- Updated dependencies [33cb357e1]
+- Updated dependencies [6bd88570c]
+- Updated dependencies [f1e42f792]
+- Updated dependencies [272389c20]
+- Updated dependencies [3de8de361]
+- Updated dependencies [be3c4f51e]
+- Updated dependencies [dbe73d5a4]
+- Updated dependencies [14ba89144]
+- Updated dependencies [c82e4b454]
+- Updated dependencies [7a2eaf4a3]
+- Updated dependencies [2ef2bb59e]
+- Updated dependencies [9b29bef37]
+- Updated dependencies [8700809b5]
+- Updated dependencies [5c3b00cde]
+- Updated dependencies [01272ab7d]
+- Updated dependencies [9822357d6]
+- Updated dependencies [3d9a04648]
+- Updated dependencies [da72e73a9]
+- Updated dependencies [a0955c479]
+- Updated dependencies [3eb3a1de8]
+- Updated dependencies [0c9047698]
+- Updated dependencies [4593333bd]
+- Updated dependencies [d5ef1b6e5]
+- Updated dependencies [0a7b42a6d]
+- Updated dependencies [3de8de361]
+- Updated dependencies [dd348cf03]
+- Updated dependencies [57c17e02a]
+- Updated dependencies [65f1372dd]
+- Updated dependencies [a09239308]
+- Updated dependencies [fe335e6ba]
+- Updated dependencies [5dc25faad]
+- Updated dependencies [64234baaf]
+- Updated dependencies [79c2165cb]
+- Updated dependencies [d3170ba41]
+- Updated dependencies [a6ffb8088]
+- Updated dependencies [3304eb83b]
+- Updated dependencies [4189171ef]
+- Updated dependencies [210840114]
+- Updated dependencies [77bdf907f]
+- Updated dependencies [a74df16ec]
+- Updated dependencies [0f7aa6507]
+- Updated dependencies [9b60bf700]
+- Updated dependencies [64fb649eb]
+- Updated dependencies [a6b0c4e5f]
+  - @mysten/sui.js@0.30.0
+
 ## 0.4.3
 
 ### Patch Changes

package/README.md

@@ -36,24 +36,24 @@ Features are standard methods consumers can use to interact with a wallet. To be
 
 - `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:signTransaction` - Used to prompt the user to sign a transaction, and return the serializated transaction and transaction signature back to the user. This method does not submit the transaction for execution.
-- `sui:signAndExecuteTransaction` - Used to prompt the user to sign a transaction, then submit it for execution to the blockchain.
+- `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 {
-  ConnectFeature,
-  ConnectMethod,
-  EventsFeature,
-  EventsOnMethod,
+  StandardConnectFeature,
+  StandardConnectMethod,
+  StandardEventsFeature,
+  StandardEventsOnMethod,
   SuiFeatures,
-  SuiTransactionMethod,
-  SuiSignAndExecuteTransactionMethod
+  SuiSignTransactionBlockMethod,
+  SuiSignAndExecuteTransactionBlockMethod
 } from "@mysten/wallet-standard";
 
 class YourWallet implements Wallet {
-  get features(): ConnectFeature & EventsFeature & SuiFeatures {
+  get features(): StandardConnectFeature & StandardEventsFeature & SuiFeatures {
     return {
       "standard:connect": {
         version: "1.0.0",
@@ -63,31 +63,31 @@ class YourWallet implements Wallet {
         version: "1.0.0",
         on: this.#on,
       },
-      "sui:signTransaction": {
+      "sui:signTransactionBlock": {
         version: "1.0.0",
-        signTransaction: this.#signTransaction,
+        signTransactionBlock: this.#signTransactionBlock,
       },
-      "sui:signAndExecuteTransaction": {
+      "sui:signAndExecuteTransactionBlock": {
         version: "1.1.0",
-        signAndExecuteTransaction: this.#signAndExecuteTransaction,
+        signAndExecuteTransactionBlock: this.#signAndExecuteTransaction,
       },
     };
   },
 
-  #on: EventsOnMethod = () => {
-    // Your wallet's events on implementation.
+  #on: StandardEventsOnMethod = () => {
+    // Your wallet's on implementation.
   };
 
-  #connect: ConnectMethod = () => {
-    // Your wallet's connect implementation
+  #connect: StandardConnectMethod = () => {
+    // Your wallet's implementation
   };
 
-  #signTransaction: SuiTransactionMethod = () => {
-    // Your wallet's signTransaction implementation
+  #signTransactionBlock: SuiSignTransactionBlockMethod = () => {
+    // Your wallet's implementation
   };
 
-  #signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = () => {
-    // Your wallet's signAndExecuteTransaction implementation
+  #signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod = () => {
+    // Your wallet's implementation
   };
 }
 ```
@@ -114,7 +114,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"],
+          features: ["sui:signAndExecuteTransactionBlock"],
         })
     );
   }

package/dist/detect.d.ts

@@ -1,4 +1,4 @@
-import { ConnectFeature, DisconnectFeature, EventsFeature, Wallet, WalletWithFeatures } from "@wallet-standard/core";
+import { StandardConnectFeature, StandardDisconnectFeature, StandardEventsFeature, Wallet, WalletWithFeatures } from "@wallet-standard/core";
 import { SuiFeatures } from "./features";
-export type StandardWalletAdapterWallet = WalletWithFeatures<ConnectFeature & EventsFeature & SuiFeatures & Partial<DisconnectFeature>>;
-export declare function isStandardWalletAdapterCompatibleWallet(wallet: Wallet): wallet is StandardWalletAdapterWallet;
+export type StandardWalletAdapterWallet = WalletWithFeatures<StandardConnectFeature & StandardEventsFeature & SuiFeatures & Partial<StandardDisconnectFeature>>;
+export declare function isStandardWalletAdapterCompatibleWallet(wallet: Wallet, features?: string[]): wallet is StandardWalletAdapterWallet;

package/dist/features/index.d.ts

@@ -1,10 +1,12 @@
 import type { WalletWithFeatures } from "@wallet-standard/core";
-import type { SuiSignTransactionFeature } from "./suiSignTransaction";
-import type { SuiSignAndExecuteTransactionFeature } from "./suiSignAndExecuteTransaction";
+import type { SuiSignTransactionBlockFeature } from "./suiSignTransactionBlock";
+import type { SuiSignAndExecuteTransactionBlockFeature } from "./suiSignAndExecuteTransactionBlock";
+import { SuiSignMessageFeature } from "./suiSignMessage";
 /**
  * Wallet Standard features that are unique to Sui, and that all Sui wallets are expected to implement.
  */
-export type SuiFeatures = SuiSignTransactionFeature & SuiSignAndExecuteTransactionFeature;
+export type SuiFeatures = SuiSignTransactionBlockFeature & SuiSignAndExecuteTransactionBlockFeature & SuiSignMessageFeature;
 export type WalletWithSuiFeatures = WalletWithFeatures<SuiFeatures>;
-export * from "./suiSignTransaction";
-export * from "./suiSignAndExecuteTransaction";
+export * from "./suiSignMessage";
+export * from "./suiSignTransactionBlock";
+export * from "./suiSignAndExecuteTransactionBlock";

package/dist/features/suiSignAndExecuteTransactionBlock.d.ts

@@ -0,0 +1,31 @@
+import type { ExecuteTransactionRequestType, SuiTransactionBlockResponse, SuiTransactionBlockResponseOptions } from "@mysten/sui.js";
+import type { SuiSignTransactionBlockInput } from "./suiSignTransactionBlock";
+/** The latest API version of the signAndExecuteTransactionBlock API. */
+export type SuiSignAndExecuteTransactionBlockVersion = "1.0.0";
+/**
+ * A Wallet Standard feature for signing a transaction, and submitting it to the
+ * network. The wallet is expected to submit the transaction to the network via RPC,
+ * and return the transaction response.
+ */
+export type SuiSignAndExecuteTransactionBlockFeature = {
+    /** Namespace for the feature. */
+    "sui:signAndExecuteTransactionBlock": {
+        /** Version of the feature API. */
+        version: SuiSignAndExecuteTransactionBlockVersion;
+        signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod;
+    };
+};
+export type SuiSignAndExecuteTransactionBlockMethod = (input: SuiSignAndExecuteTransactionBlockInput) => Promise<SuiSignAndExecuteTransactionBlockOutput>;
+/** Input for signing and sending transactions. */
+export interface SuiSignAndExecuteTransactionBlockInput extends SuiSignTransactionBlockInput {
+    /**
+     * `WaitForEffectsCert` or `WaitForLocalExecution`, see details in `ExecuteTransactionRequestType`.
+     * Defaults to `WaitForLocalExecution` if options.showEffects or options.showEvents is true
+     */
+    requestType?: ExecuteTransactionRequestType;
+    /** specify which fields to return (e.g., transaction, effects, events, etc). By default, only the transaction digest will be returned. */
+    options?: SuiTransactionBlockResponseOptions;
+}
+/** Output of signing and sending transactions. */
+export interface SuiSignAndExecuteTransactionBlockOutput extends SuiTransactionBlockResponse {
+}

package/dist/features/suiSignMessage.d.ts

@@ -0,0 +1,25 @@
+import type { SignedMessage } from "@mysten/sui.js";
+import type { WalletAccount } from "@wallet-standard/core";
+/** The latest API version of the signMessage API. */
+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.
+ */
+export type SuiSignMessageFeature = {
+    /** Namespace for the feature. */
+    "sui:signMessage": {
+        /** Version of the feature API. */
+        version: SuiSignMessageVersion;
+        signMessage: SuiSignMessageMethod;
+    };
+};
+export type SuiSignMessageMethod = (input: SuiSignMessageInput) => Promise<SuiSignMessageOutput>;
+/** Input for signing messages. */
+export interface SuiSignMessageInput {
+    message: Uint8Array;
+    account: WalletAccount;
+}
+/** Output of signing messages. */
+export interface SuiSignMessageOutput extends SignedMessage {
+}

package/dist/features/suiSignTransactionBlock.d.ts

@@ -0,0 +1,26 @@
+import type { SignedTransaction, TransactionBlock } from "@mysten/sui.js";
+import type { IdentifierString, WalletAccount } from "@wallet-standard/core";
+/** The latest API version of the signTransactionBlock API. */
+export type SuiSignTransactionBlockVersion = "1.0.0";
+/**
+ * A Wallet Standard feature for signing a transaction, and returning the
+ * serialized transaction and transaction signature.
+ */
+export type SuiSignTransactionBlockFeature = {
+    /** Namespace for the feature. */
+    "sui:signTransactionBlock": {
+        /** Version of the feature API. */
+        version: SuiSignTransactionBlockVersion;
+        signTransactionBlock: SuiSignTransactionBlockMethod;
+    };
+};
+export type SuiSignTransactionBlockMethod = (input: SuiSignTransactionBlockInput) => Promise<SuiSignTransactionBlockOutput>;
+/** Input for signing transactions. */
+export interface SuiSignTransactionBlockInput {
+    transactionBlock: TransactionBlock;
+    account: WalletAccount;
+    chain: IdentifierString;
+}
+/** Output of signing transactions. */
+export interface SuiSignTransactionBlockOutput extends SignedTransaction {
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from '@wallet-standard/core';
+export * from "@wallet-standard/core";
 export * from "./features";
 export * from "./detect";
-export * from './chains';
+export * from "./chains";

package/dist/index.js

@@ -31,8 +31,14 @@ module.exports = __toCommonJS(src_exports);
 __reExport(src_exports, require("@wallet-standard/core"), module.exports);
 
 // src/detect.ts
-function isStandardWalletAdapterCompatibleWallet(wallet) {
-  return "standard:connect" in wallet.features && "standard:events" in wallet.features && "sui:signAndExecuteTransaction" in wallet.features;
+var REQUIRED_FEATURES = [
+  "standard:connect",
+  "standard:events"
+];
+function isStandardWalletAdapterCompatibleWallet(wallet, features = []) {
+  return [...REQUIRED_FEATURES, ...features].every(
+    (feature) => feature in wallet.features
+  );
 }
 
 // src/chains.ts

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/detect.ts","../src/chains.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from '@wallet-standard/core';\n\nexport * from \"./features\";\nexport * from \"./detect\";\nexport * from './chains';\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n  ConnectFeature,\n  DisconnectFeature,\n  EventsFeature,\n  Wallet,\n  WalletWithFeatures,\n} from \"@wallet-standard/core\";\nimport { SuiFeatures } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  ConnectFeature &\n    EventsFeature &\n    SuiFeatures &\n    // Disconnect is an optional feature:\n    Partial<DisconnectFeature>\n>;\n\n// TODO: Enable filtering by subset of features:\nexport function isStandardWalletAdapterCompatibleWallet(\n  wallet: Wallet\n): wallet is StandardWalletAdapterWallet {\n  return (\n    \"standard:connect\" in wallet.features &&\n    \"standard:events\" in wallet.features &&\n    // TODO: Enable once ecosystem wallets adopt this:\n    // \"sui:signTransaction\" in wallet.features &&\n    \"sui:signAndExecuteTransaction\" in wallet.features\n  );\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/** Sui Devnet */\nexport const SUI_DEVNET_CHAIN = \"sui:devnet\";\n\n/** Sui Testnet */\nexport const SUI_TESTNET_CHAIN = \"sui:testnet\";\n\n/** Sui Localnet */\nexport const SUI_LOCALNET_CHAIN = \"sui:localnet\";\n\nexport const SUI_CHAINS = [\n  SUI_DEVNET_CHAIN,\n  SUI_TESTNET_CHAIN,\n  SUI_LOCALNET_CHAIN,\n] as const;\n\nexport type SuiChain =\n  | typeof SUI_DEVNET_CHAIN\n  | typeof SUI_TESTNET_CHAIN\n  | typeof SUI_LOCALNET_CHAIN;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,wBAAc,kCAHd;;;ACqBO,SAAS,wCACd,QACuC;AACvC,SACE,sBAAsB,OAAO,YAC7B,qBAAqB,OAAO,YAG5B,mCAAmC,OAAO;AAE9C;;;AC3BO,IAAM,mBAAmB;AAGzB,IAAM,oBAAoB;AAG1B,IAAM,qBAAqB;AAE3B,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/detect.ts","../src/chains.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from \"@wallet-standard/core\";\n\nexport * from \"./features\";\nexport * from \"./detect\";\nexport * from \"./chains\";\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n  StandardConnectFeature,\n  StandardDisconnectFeature,\n  StandardEventsFeature,\n  Wallet,\n  WalletWithFeatures,\n} from \"@wallet-standard/core\";\nimport { SuiFeatures } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  StandardConnectFeature &\n    StandardEventsFeature &\n    SuiFeatures &\n    // Disconnect is an optional feature:\n    Partial<StandardDisconnectFeature>\n>;\n\n// These features are absolutely required for wallets to function in the Sui ecosystem.\n// Eventually, as wallets have more consistent support of features, we may want to extend this list.\nconst REQUIRED_FEATURES: (keyof StandardWalletAdapterWallet[\"features\"])[] = [\n  \"standard:connect\",\n  \"standard:events\",\n];\n\nexport function isStandardWalletAdapterCompatibleWallet(\n  wallet: Wallet,\n  features: string[] = []\n): wallet is StandardWalletAdapterWallet {\n  return [...REQUIRED_FEATURES, ...features].every(\n    (feature) => feature in wallet.features\n  );\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/** Sui Devnet */\nexport const SUI_DEVNET_CHAIN = \"sui:devnet\";\n\n/** Sui Testnet */\nexport const SUI_TESTNET_CHAIN = \"sui:testnet\";\n\n/** Sui Localnet */\nexport const SUI_LOCALNET_CHAIN = \"sui:localnet\";\n\nexport const SUI_CHAINS = [\n  SUI_DEVNET_CHAIN,\n  SUI_TESTNET_CHAIN,\n  SUI_LOCALNET_CHAIN,\n] as const;\n\nexport type SuiChain =\n  | typeof SUI_DEVNET_CHAIN\n  | typeof SUI_TESTNET_CHAIN\n  | typeof SUI_LOCALNET_CHAIN;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,wBAAc,kCAHd;;;ACsBA,IAAM,oBAAuE;AAAA,EAC3E;AAAA,EACA;AACF;AAEO,SAAS,wCACd,QACA,WAAqB,CAAC,GACiB;AACvC,SAAO,CAAC,GAAG,mBAAmB,GAAG,QAAQ,EAAE;AAAA,IACzC,CAAC,YAAY,WAAW,OAAO;AAAA,EACjC;AACF;;;AC9BO,IAAM,mBAAmB;AAGzB,IAAM,oBAAoB;AAG1B,IAAM,qBAAqB;AAE3B,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/dist/index.mjs

@@ -2,8 +2,14 @@
 export * from "@wallet-standard/core";
 
 // src/detect.ts
-function isStandardWalletAdapterCompatibleWallet(wallet) {
-  return "standard:connect" in wallet.features && "standard:events" in wallet.features && "sui:signAndExecuteTransaction" in wallet.features;
+var REQUIRED_FEATURES = [
+  "standard:connect",
+  "standard:events"
+];
+function isStandardWalletAdapterCompatibleWallet(wallet, features = []) {
+  return [...REQUIRED_FEATURES, ...features].every(
+    (feature) => feature in wallet.features
+  );
 }
 
 // src/chains.ts

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/detect.ts","../src/chains.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from '@wallet-standard/core';\n\nexport * from \"./features\";\nexport * from \"./detect\";\nexport * from './chains';\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n  ConnectFeature,\n  DisconnectFeature,\n  EventsFeature,\n  Wallet,\n  WalletWithFeatures,\n} from \"@wallet-standard/core\";\nimport { SuiFeatures } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  ConnectFeature &\n    EventsFeature &\n    SuiFeatures &\n    // Disconnect is an optional feature:\n    Partial<DisconnectFeature>\n>;\n\n// TODO: Enable filtering by subset of features:\nexport function isStandardWalletAdapterCompatibleWallet(\n  wallet: Wallet\n): wallet is StandardWalletAdapterWallet {\n  return (\n    \"standard:connect\" in wallet.features &&\n    \"standard:events\" in wallet.features &&\n    // TODO: Enable once ecosystem wallets adopt this:\n    // \"sui:signTransaction\" in wallet.features &&\n    \"sui:signAndExecuteTransaction\" in wallet.features\n  );\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/** Sui Devnet */\nexport const SUI_DEVNET_CHAIN = \"sui:devnet\";\n\n/** Sui Testnet */\nexport const SUI_TESTNET_CHAIN = \"sui:testnet\";\n\n/** Sui Localnet */\nexport const SUI_LOCALNET_CHAIN = \"sui:localnet\";\n\nexport const SUI_CHAINS = [\n  SUI_DEVNET_CHAIN,\n  SUI_TESTNET_CHAIN,\n  SUI_LOCALNET_CHAIN,\n] as const;\n\nexport type SuiChain =\n  | typeof SUI_DEVNET_CHAIN\n  | typeof SUI_TESTNET_CHAIN\n  | typeof SUI_LOCALNET_CHAIN;\n"],"mappings":";AAGA,cAAc;;;ACkBP,SAAS,wCACd,QACuC;AACvC,SACE,sBAAsB,OAAO,YAC7B,qBAAqB,OAAO,YAG5B,mCAAmC,OAAO;AAE9C;;;AC3BO,IAAM,mBAAmB;AAGzB,IAAM,oBAAoB;AAG1B,IAAM,qBAAqB;AAE3B,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/detect.ts","../src/chains.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nexport * from \"@wallet-standard/core\";\n\nexport * from \"./features\";\nexport * from \"./detect\";\nexport * from \"./chains\";\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport {\n  StandardConnectFeature,\n  StandardDisconnectFeature,\n  StandardEventsFeature,\n  Wallet,\n  WalletWithFeatures,\n} from \"@wallet-standard/core\";\nimport { SuiFeatures } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  StandardConnectFeature &\n    StandardEventsFeature &\n    SuiFeatures &\n    // Disconnect is an optional feature:\n    Partial<StandardDisconnectFeature>\n>;\n\n// These features are absolutely required for wallets to function in the Sui ecosystem.\n// Eventually, as wallets have more consistent support of features, we may want to extend this list.\nconst REQUIRED_FEATURES: (keyof StandardWalletAdapterWallet[\"features\"])[] = [\n  \"standard:connect\",\n  \"standard:events\",\n];\n\nexport function isStandardWalletAdapterCompatibleWallet(\n  wallet: Wallet,\n  features: string[] = []\n): wallet is StandardWalletAdapterWallet {\n  return [...REQUIRED_FEATURES, ...features].every(\n    (feature) => feature in wallet.features\n  );\n}\n","// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n/** Sui Devnet */\nexport const SUI_DEVNET_CHAIN = \"sui:devnet\";\n\n/** Sui Testnet */\nexport const SUI_TESTNET_CHAIN = \"sui:testnet\";\n\n/** Sui Localnet */\nexport const SUI_LOCALNET_CHAIN = \"sui:localnet\";\n\nexport const SUI_CHAINS = [\n  SUI_DEVNET_CHAIN,\n  SUI_TESTNET_CHAIN,\n  SUI_LOCALNET_CHAIN,\n] as const;\n\nexport type SuiChain =\n  | typeof SUI_DEVNET_CHAIN\n  | typeof SUI_TESTNET_CHAIN\n  | typeof SUI_LOCALNET_CHAIN;\n"],"mappings":";AAGA,cAAc;;;ACmBd,IAAM,oBAAuE;AAAA,EAC3E;AAAA,EACA;AACF;AAEO,SAAS,wCACd,QACA,WAAqB,CAAC,GACiB;AACvC,SAAO,CAAC,GAAG,mBAAmB,GAAG,QAAQ,EAAE;AAAA,IACzC,CAAC,YAAY,WAAW,OAAO;AAAA,EACjC;AACF;;;AC9BO,IAAM,mBAAmB;AAGzB,IAAM,oBAAoB;AAG1B,IAAM,qBAAqB;AAE3B,IAAM,aAAa;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten/wallet-standard",
-  "version": "0.4.3",
+  "version": "0.5.1",
   "description": "A suite of standard utilities for implementing wallets based on the Wallet Standard.",
   "license": "Apache-2.0",
   "author": "Mysten Labs <build@mystenlabs.com>",
@@ -20,16 +20,18 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@wallet-standard/core": "1.0.1",
-    "@mysten/sui.js": "0.29.1"
+    "@wallet-standard/core": "1.0.3",
+    "@mysten/sui.js": "0.31.0"
   },
   "devDependencies": {
-    "tsup": "^6.5.0",
+    "tsup": "^6.7.0",
     "typescript": "^4.9.4"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
-    "build": "pnpm build:types && tsup ./src/index.ts --format esm,cjs --sourcemap",
+    "dev": "pnpm build --watch",
+    "build": "pnpm build:types && pnpm build:tsup",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
     "build:types": "tsc --build"
   }
 }

package/src/detect.ts

@@ -2,31 +2,34 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
-  ConnectFeature,
-  DisconnectFeature,
-  EventsFeature,
+  StandardConnectFeature,
+  StandardDisconnectFeature,
+  StandardEventsFeature,
   Wallet,
   WalletWithFeatures,
 } from "@wallet-standard/core";
 import { SuiFeatures } from "./features";
 
 export type StandardWalletAdapterWallet = WalletWithFeatures<
-  ConnectFeature &
-    EventsFeature &
+  StandardConnectFeature &
+    StandardEventsFeature &
     SuiFeatures &
     // Disconnect is an optional feature:
-    Partial<DisconnectFeature>
+    Partial<StandardDisconnectFeature>
 >;
 
-// TODO: Enable filtering by subset of features:
+// These features are absolutely required for wallets to function in the Sui ecosystem.
+// Eventually, as wallets have more consistent support of features, we may want to extend this list.
+const REQUIRED_FEATURES: (keyof StandardWalletAdapterWallet["features"])[] = [
+  "standard:connect",
+  "standard:events",
+];
+
 export function isStandardWalletAdapterCompatibleWallet(
-  wallet: Wallet
+  wallet: Wallet,
+  features: string[] = []
 ): wallet is StandardWalletAdapterWallet {
-  return (
-    "standard:connect" in wallet.features &&
-    "standard:events" in wallet.features &&
-    // TODO: Enable once ecosystem wallets adopt this:
-    // "sui:signTransaction" in wallet.features &&
-    "sui:signAndExecuteTransaction" in wallet.features
+  return [...REQUIRED_FEATURES, ...features].every(
+    (feature) => feature in wallet.features
   );
 }

package/src/features/index.ts

@@ -2,16 +2,19 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { WalletWithFeatures } from "@wallet-standard/core";
-import type { SuiSignTransactionFeature } from "./suiSignTransaction";
-import type { SuiSignAndExecuteTransactionFeature } from "./suiSignAndExecuteTransaction";
+import type { SuiSignTransactionBlockFeature } from "./suiSignTransactionBlock";
+import type { SuiSignAndExecuteTransactionBlockFeature } from "./suiSignAndExecuteTransactionBlock";
+import { SuiSignMessageFeature } from "./suiSignMessage";
 
 /**
  * Wallet Standard features that are unique to Sui, and that all Sui wallets are expected to implement.
  */
-export type SuiFeatures = SuiSignTransactionFeature &
-  SuiSignAndExecuteTransactionFeature;
+export type SuiFeatures = SuiSignTransactionBlockFeature &
+  SuiSignAndExecuteTransactionBlockFeature &
+  SuiSignMessageFeature;
 
 export type WalletWithSuiFeatures = WalletWithFeatures<SuiFeatures>;
 
-export * from "./suiSignTransaction";
-export * from "./suiSignAndExecuteTransaction";
+export * from "./suiSignMessage";
+export * from "./suiSignTransactionBlock";
+export * from "./suiSignAndExecuteTransactionBlock";

package/src/features/suiSignAndExecuteTransactionBlock.ts

@@ -0,0 +1,46 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type {
+  ExecuteTransactionRequestType,
+  SuiTransactionBlockResponse,
+  SuiTransactionBlockResponseOptions,
+} from "@mysten/sui.js";
+import type { SuiSignTransactionBlockInput } from "./suiSignTransactionBlock";
+
+/** The latest API version of the signAndExecuteTransactionBlock API. */
+export type SuiSignAndExecuteTransactionBlockVersion = "1.0.0";
+
+/**
+ * A Wallet Standard feature for signing a transaction, and submitting it to the
+ * network. The wallet is expected to submit the transaction to the network via RPC,
+ * and return the transaction response.
+ */
+export type SuiSignAndExecuteTransactionBlockFeature = {
+  /** Namespace for the feature. */
+  "sui:signAndExecuteTransactionBlock": {
+    /** Version of the feature API. */
+    version: SuiSignAndExecuteTransactionBlockVersion;
+    signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod;
+  };
+};
+
+export type SuiSignAndExecuteTransactionBlockMethod = (
+  input: SuiSignAndExecuteTransactionBlockInput
+) => Promise<SuiSignAndExecuteTransactionBlockOutput>;
+
+/** Input for signing and sending transactions. */
+export interface SuiSignAndExecuteTransactionBlockInput
+  extends SuiSignTransactionBlockInput {
+  /**
+   * `WaitForEffectsCert` or `WaitForLocalExecution`, see details in `ExecuteTransactionRequestType`.
+   * Defaults to `WaitForLocalExecution` if options.showEffects or options.showEvents is true
+   */
+  requestType?: ExecuteTransactionRequestType;
+  /** specify which fields to return (e.g., transaction, effects, events, etc). By default, only the transaction digest will be returned. */
+  options?: SuiTransactionBlockResponseOptions;
+}
+
+/** Output of signing and sending transactions. */
+export interface SuiSignAndExecuteTransactionBlockOutput
+  extends SuiTransactionBlockResponse {}

package/src/features/suiSignMessage.ts

@@ -0,0 +1,34 @@
+// 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. */
+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.
+ */
+export type SuiSignMessageFeature = {
+  /** Namespace for the feature. */
+  "sui:signMessage": {
+    /** Version of the feature API. */
+    version: SuiSignMessageVersion;
+    signMessage: SuiSignMessageMethod;
+  };
+};
+
+export type SuiSignMessageMethod = (
+  input: SuiSignMessageInput
+) => Promise<SuiSignMessageOutput>;
+
+/** Input for signing messages. */
+export interface SuiSignMessageInput {
+  message: Uint8Array;
+  account: WalletAccount;
+}
+
+/** Output of signing messages. */
+export interface SuiSignMessageOutput extends SignedMessage {}

package/src/features/suiSignTransactionBlock.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { SignedTransaction, TransactionBlock } from "@mysten/sui.js";
+import type { IdentifierString, WalletAccount } from "@wallet-standard/core";
+
+/** The latest API version of the signTransactionBlock API. */
+export type SuiSignTransactionBlockVersion = "1.0.0";
+
+/**
+ * A Wallet Standard feature for signing a transaction, and returning the
+ * serialized transaction and transaction signature.
+ */
+export type SuiSignTransactionBlockFeature = {
+  /** Namespace for the feature. */
+  "sui:signTransactionBlock": {
+    /** Version of the feature API. */
+    version: SuiSignTransactionBlockVersion;
+    signTransactionBlock: SuiSignTransactionBlockMethod;
+  };
+};
+
+export type SuiSignTransactionBlockMethod = (
+  input: SuiSignTransactionBlockInput
+) => Promise<SuiSignTransactionBlockOutput>;
+
+/** Input for signing transactions. */
+export interface SuiSignTransactionBlockInput {
+  transactionBlock: TransactionBlock;
+  account: WalletAccount;
+  chain: IdentifierString;
+}
+
+/** Output of signing transactions. */
+export interface SuiSignTransactionBlockOutput extends SignedTransaction {}

package/src/index.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-export * from '@wallet-standard/core';
+export * from "@wallet-standard/core";
 
 export * from "./features";
 export * from "./detect";
-export * from './chains';
+export * from "./chains";

package/dist/features/suiSignAndExecuteTransaction.d.ts

@@ -1,29 +0,0 @@
-import type { ExecuteTransactionRequestType, SignableTransaction, SuiTransactionResponse } from "@mysten/sui.js";
-/** The latest API version of the signAndExecuteTransaction API. */
-export type SuiSignAndExecuteTransactionVersion = "1.1.0";
-/**
- * A Wallet Standard feature for signing a transaction, and submitting it to the
- * network. The wallet is expected to submit the transaction to the network via RPC,
- * and return the transaction response.
- */
-export type SuiSignAndExecuteTransactionFeature = {
-    /** Namespace for the feature. */
-    "sui:signAndExecuteTransaction": {
-        /** Version of the feature API. */
-        version: SuiSignAndExecuteTransactionVersion;
-        signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod;
-    };
-};
-export type SuiSignAndExecuteTransactionMethod = (input: SuiSignAndExecuteTransactionInput) => Promise<SuiSignAndExecuteTransactionOutput>;
-/** Input for signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionInput {
-    transaction: SignableTransaction;
-    options?: SuiSignAndExecuteTransactionOptions;
-}
-/** Output of signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionOutput extends SuiTransactionResponse {
-}
-/** Options for signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionOptions {
-    requestType?: ExecuteTransactionRequestType;
-}

package/dist/features/suiSignTransaction.d.ts

@@ -1,27 +0,0 @@
-import type { SignableTransaction, SignedTransaction } from "@mysten/sui.js";
-/** The latest API version of the signTransaction API. */
-export type SuiSignTransactionVersion = "1.0.0";
-/**
- * A Wallet Standard feature for signing a transaction, and returning the
- * serialized transaction and transaction signature.
- */
-export type SuiSignTransactionFeature = {
-    /** Namespace for the feature. */
-    "sui:signTransaction": {
-        /** Version of the feature API. */
-        version: SuiSignTransactionVersion;
-        signTransaction: SuiSignTransactionMethod;
-    };
-};
-export type SuiSignTransactionMethod = (input: SuiSignTransactionInput) => Promise<SuiSignTransactionOutput>;
-/** Input for signing transactions. */
-export interface SuiSignTransactionInput {
-    transaction: SignableTransaction;
-    options?: SuiSignTransactionOptions;
-}
-/** Output of signing transactions. */
-export interface SuiSignTransactionOutput extends SignedTransaction {
-}
-/** Options for signing transactions. */
-export interface SuiSignTransactionOptions {
-}

package/src/features/suiSignAndExecuteTransaction.ts

@@ -1,44 +0,0 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
-
-import type {
-  ExecuteTransactionRequestType,
-  SignableTransaction,
-  SuiTransactionResponse,
-} from "@mysten/sui.js";
-
-/** The latest API version of the signAndExecuteTransaction API. */
-export type SuiSignAndExecuteTransactionVersion = "1.1.0";
-
-/**
- * A Wallet Standard feature for signing a transaction, and submitting it to the
- * network. The wallet is expected to submit the transaction to the network via RPC,
- * and return the transaction response.
- */
-export type SuiSignAndExecuteTransactionFeature = {
-  /** Namespace for the feature. */
-  "sui:signAndExecuteTransaction": {
-    /** Version of the feature API. */
-    version: SuiSignAndExecuteTransactionVersion;
-    signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod;
-  };
-};
-
-export type SuiSignAndExecuteTransactionMethod = (
-  input: SuiSignAndExecuteTransactionInput
-) => Promise<SuiSignAndExecuteTransactionOutput>;
-
-/** Input for signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionInput {
-  transaction: SignableTransaction;
-  options?: SuiSignAndExecuteTransactionOptions;
-}
-
-/** Output of signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionOutput
-  extends SuiTransactionResponse {}
-
-/** Options for signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionOptions {
-  requestType?: ExecuteTransactionRequestType;
-}

package/src/features/suiSignTransaction.ts

@@ -1,36 +0,0 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
-
-import type { SignableTransaction, SignedTransaction } from "@mysten/sui.js";
-
-/** The latest API version of the signTransaction API. */
-export type SuiSignTransactionVersion = "1.0.0";
-
-/**
- * A Wallet Standard feature for signing a transaction, and returning the
- * serialized transaction and transaction signature.
- */
-export type SuiSignTransactionFeature = {
-  /** Namespace for the feature. */
-  "sui:signTransaction": {
-    /** Version of the feature API. */
-    version: SuiSignTransactionVersion;
-    signTransaction: SuiSignTransactionMethod;
-  };
-};
-
-export type SuiSignTransactionMethod = (
-  input: SuiSignTransactionInput
-) => Promise<SuiSignTransactionOutput>;
-
-/** Input for signing transactions. */
-export interface SuiSignTransactionInput {
-  transaction: SignableTransaction;
-  options?: SuiSignTransactionOptions;
-}
-
-/** Output of signing transactions. */
-export interface SuiSignTransactionOutput extends SignedTransaction {}
-
-/** Options for signing transactions. */
-export interface SuiSignTransactionOptions {}