@mysten/wallet-standard 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @mysten/wallet-standard
 
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [a67cc044b]
+- Updated dependencies [24bdb66c6]
+- Updated dependencies [a67cc044b]
+- Updated dependencies [a67cc044b]
+  - @mysten/sui.js@0.28.0
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -36,6 +36,7 @@ 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.
 
 You can implement these features in your wallet class under the `features` property:
@@ -46,12 +47,13 @@ import {
   ConnectMethod,
   EventsFeature,
   EventsOnMethod,
-  SuiSignAndExecuteTransactionFeature,
+  SuiFeatures,
+  SuiTransactionMethod,
   SuiSignAndExecuteTransactionMethod
 } from "@mysten/wallet-standard";
 
 class YourWallet implements Wallet {
-  get features(): ConnectFeature & EventsFeature & SuiSignAndExecuteTransactionFeature {
+  get features(): ConnectFeature & EventsFeature & SuiFeatures {
     return {
       "standard:connect": {
         version: "1.0.0",
@@ -60,9 +62,13 @@ class YourWallet implements Wallet {
       "standard:events": {
         version: "1.0.0",
         on: this.#on,
-      }
-      "sui:signAndExecuteTransaction": {
+      },
+      "sui:signTransaction": {
         version: "1.0.0",
+        signTransaction: this.#signTransaction,
+      },
+      "sui:signAndExecuteTransaction": {
+        version: "1.1.0",
         signAndExecuteTransaction: this.#signAndExecuteTransaction,
       },
     };
@@ -76,6 +82,10 @@ class YourWallet implements Wallet {
     // Your wallet's connect implementation
   };
 
+  #signTransaction: SuiTransactionMethod = () => {
+    // Your wallet's signTransaction implementation
+  };
+
   #signAndExecuteTransaction: SuiSignAndExecuteTransactionMethod = () => {
     // Your wallet's signAndExecuteTransaction implementation
   };
@@ -116,7 +126,7 @@ class YourWallet implements Wallet {
 Once you have a compatible interface for your wallet, you can register it using the `registerWallet` function.
 
 ```typescript
-import { registerWallet } from '@mysten/wallet-standard';
+import { registerWallet } from "@mysten/wallet-standard";
 
 registerWallet(new YourWallet());
 ```

package/dist/detect.d.ts

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

package/dist/features/index.d.ts

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

package/dist/features/suiSignTransaction.d.ts

@@ -0,0 +1,27 @@
+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/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 { SuiSignAndExecuteTransactionFeature } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  ConnectFeature &\n    EventsFeature &\n    SuiSignAndExecuteTransactionFeature &\n    // Disconnect is an optional feature:\n    Partial<DisconnectFeature>\n>;\n\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    \"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;;;ACoBO,SAAS,wCACd,QACuC;AACvC,SACE,sBAAsB,OAAO,YAC7B,qBAAqB,OAAO,YAC5B,mCAAmC,OAAO;AAE9C;;;ACxBO,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  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":[]}

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 { SuiSignAndExecuteTransactionFeature } from \"./features\";\n\nexport type StandardWalletAdapterWallet = WalletWithFeatures<\n  ConnectFeature &\n    EventsFeature &\n    SuiSignAndExecuteTransactionFeature &\n    // Disconnect is an optional feature:\n    Partial<DisconnectFeature>\n>;\n\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    \"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;;;ACiBP,SAAS,wCACd,QACuC;AACvC,SACE,sBAAsB,OAAO,YAC7B,qBAAqB,OAAO,YAC5B,mCAAmC,OAAO;AAE9C;;;ACxBO,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  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":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mysten/wallet-standard",
-  "version": "0.4.0",
+  "version": "0.4.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>",
@@ -21,7 +21,7 @@
   ],
   "dependencies": {
     "@wallet-standard/core": "1.0.1",
-    "@mysten/sui.js": "0.27.0"
+    "@mysten/sui.js": "0.28.0"
   },
   "devDependencies": {
     "tsup": "^6.5.0",

package/src/detect.ts

@@ -8,22 +8,25 @@ import {
   Wallet,
   WalletWithFeatures,
 } from "@wallet-standard/core";
-import { SuiSignAndExecuteTransactionFeature } from "./features";
+import { SuiFeatures } from "./features";
 
 export type StandardWalletAdapterWallet = WalletWithFeatures<
   ConnectFeature &
     EventsFeature &
-    SuiSignAndExecuteTransactionFeature &
+    SuiFeatures &
     // Disconnect is an optional feature:
     Partial<DisconnectFeature>
 >;
 
+// TODO: Enable filtering by subset of features:
 export function isStandardWalletAdapterCompatibleWallet(
   wallet: Wallet
 ): 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
   );
 }

package/src/features/index.ts

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

package/src/features/suiSignTransaction.ts

@@ -0,0 +1,36 @@
+// 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 {}