[wallet-adapter] Wire through options for request type (MystenLabs#7944)

artifactstaking · Feb 1, 2023 · 96e883f · 96e883f
1 parent fe574ee
commit 96e883f
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 13 deletions.
diff --git a/.changeset/hungry-rabbits-fetch.md b/.changeset/hungry-rabbits-fetch.md
@@ -0,0 +1,8 @@
+---
+"@mysten/wallet-adapter-wallet-standard": minor
+"@mysten/wallet-adapter-unsafe-burner": minor
+"@mysten/wallet-adapter-base": minor
+"@mysten/wallet-standard": minor
+---
+
+Update wallet adapter and wallet standard to support passing through the desired request type.
diff --git a/apps/wallet/src/dapp-interface/WalletStandardInterface.ts b/apps/wallet/src/dapp-interface/WalletStandardInterface.ts
@@ -107,7 +107,7 @@ export class SuiWallet implements Wallet {
                 on: this.#on,
             },
             'sui:signAndExecuteTransaction': {
-                version: '1.0.0',
+                version: '1.1.0',
                 signAndExecuteTransaction: this.#signAndExecuteTransaction,
             },
             'suiWallet:stake': {
@@ -216,6 +216,7 @@ export class SuiWallet implements Wallet {
                 transaction: {
                     type: 'v2',
                     data: input.transaction,
+                    options: input.options,
                 },
             }),
             (response) => response.result

diff --git a/apps/wallet/src/shared/messaging/messages/payloads/transactions/ExecuteTransactionRequest.ts b/apps/wallet/src/shared/messaging/messages/payloads/transactions/ExecuteTransactionRequest.ts
@@ -1,13 +1,19 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { type SuiSignAndExecuteTransactionOptions } from '@mysten/wallet-standard';
+
 import { isBasePayload } from '_payloads';
 
 import type { MoveCallTransaction, SignableTransaction } from '@mysten/sui.js';
 import type { BasePayload, Payload } from '_payloads';
 
 export type TransactionDataType =
-    | { type: 'v2'; data: SignableTransaction }
+    | {
+          type: 'v2';
+          data: SignableTransaction;
+          options?: SuiSignAndExecuteTransactionOptions;
+      }
     | { type: 'move-call'; data: MoveCallTransaction }
     | { type: 'serialized-move-call'; data: string };
 

diff --git a/apps/wallet/src/ui/app/redux/slices/transaction-requests/index.ts b/apps/wallet/src/ui/app/redux/slices/transaction-requests/index.ts
@@ -163,7 +163,12 @@ export const respondToTransactionRequest = createAsyncThunk<
                               }
                             : txRequest.tx.data;
 
-                    response = await signer.signAndExecuteTransaction(txn);
+                    response = await signer.signAndExecuteTransaction(
+                        txn,
+                        txRequest.tx.type === 'v2'
+                            ? txRequest.tx.options?.requestType
+                            : undefined
+                    );
                 } else if (txRequest.tx.type === 'serialized-move-call') {
                     const txBytes = new Base64DataBuffer(txRequest.tx.data);
                     response = await signer.signAndExecuteTransaction(txBytes);

diff --git a/sdk/wallet-adapter/adapters/base-adapter/src/index.ts b/sdk/wallet-adapter/adapters/base-adapter/src/index.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
+  ExecuteTransactionRequestType,
   SignableTransaction,
   SuiAddress,
   SuiTransactionResponse,
@@ -29,7 +30,10 @@ export interface WalletAdapter {
    * Suggest a transaction for the user to sign. Supports all valid transaction types.
    */
   signAndExecuteTransaction(
-    transaction: SignableTransaction
+    transaction: SignableTransaction,
+    options?: {
+      requestType?: ExecuteTransactionRequestType;
+    }
   ): Promise<SuiTransactionResponse>;
 
   getAccounts: () => Promise<SuiAddress[]>;

diff --git a/sdk/wallet-adapter/adapters/unsafe-burner/src/index.ts b/sdk/wallet-adapter/adapters/unsafe-burner/src/index.ts
@@ -3,6 +3,7 @@
 
 import {
   Ed25519Keypair,
+  ExecuteTransactionRequestType,
   getCertifiedTransaction,
   getTransactionEffects,
   JsonRpcProvider,
@@ -48,8 +49,14 @@ export class UnsafeBurnerWalletAdapter implements WalletAdapter {
     return [this.#keypair.getPublicKey().toSuiAddress()];
   }
 
-  async signAndExecuteTransaction(transaction: SignableTransaction) {
-    const response = await this.#signer.signAndExecuteTransaction(transaction);
+  async signAndExecuteTransaction(
+    transaction: SignableTransaction,
+    options?: { requestType?: ExecuteTransactionRequestType }
+  ) {
+    const response = await this.#signer.signAndExecuteTransaction(
+      transaction,
+      options?.requestType
+    );
 
     return {
       certificate: getCertifiedTransaction(response)!,

diff --git a/sdk/wallet-adapter/adapters/wallet-standard-adapter/src/StandardWalletAdapter.ts b/sdk/wallet-adapter/adapters/wallet-standard-adapter/src/StandardWalletAdapter.ts
@@ -1,7 +1,10 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { SignableTransaction } from "@mysten/sui.js";
+import {
+  ExecuteTransactionRequestType,
+  SignableTransaction,
+} from "@mysten/sui.js";
 import {
   WalletAdapter,
   WalletAdapterEvents,
@@ -86,11 +89,15 @@ export class StandardWalletAdapter implements WalletAdapter {
     }
   }
 
-  async signAndExecuteTransaction(transaction: SignableTransaction) {
+  async signAndExecuteTransaction(
+    transaction: SignableTransaction,
+    options?: { requestType?: ExecuteTransactionRequestType }
+  ) {
     return this.#wallet.features[
       "sui:signAndExecuteTransaction"
     ].signAndExecuteTransaction({
       transaction,
+      options,
     });
   }
 

diff --git a/sdk/wallet-adapter/wallet-kit-core/src/index.ts b/sdk/wallet-adapter/wallet-kit-core/src/index.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import {
+  ExecuteTransactionRequestType,
   SignableTransaction,
   SuiAddress,
   SuiTransactionResponse,
@@ -46,7 +47,8 @@ export interface WalletKitCore {
   connect(walletName: string): Promise<void>;
   disconnect(): Promise<void>;
   signAndExecuteTransaction(
-    transaction: SignableTransaction
+    transaction: SignableTransaction,
+    options?: { requestType?: ExecuteTransactionRequestType }
   ): Promise<SuiTransactionResponse>;
 }
 
@@ -198,14 +200,17 @@ export function createWalletKitCore({
       disconnected();
     },
 
-    signAndExecuteTransaction(transaction) {
+    signAndExecuteTransaction(transaction, options) {
       if (!internalState.currentWallet) {
         throw new Error(
           "No wallet is currently connected, cannot call `signAndExecuteTransaction`."
         );
       }
 
-      return internalState.currentWallet.signAndExecuteTransaction(transaction);
+      return internalState.currentWallet.signAndExecuteTransaction(
+        transaction,
+        options
+      );
     },
   };
 }
diff --git a/sdk/wallet-adapter/wallet-standard/src/features/suiSignAndExecuteTransaction.ts b/sdk/wallet-adapter/wallet-standard/src/features/suiSignAndExecuteTransaction.ts
@@ -2,12 +2,13 @@
 // 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.0.0";
+export type SuiSignAndExecuteTransactionVersion = "1.1.0";
 
 /**
  * A Wallet Standard feature for signing a transaction, and submitting it to the
@@ -38,4 +39,6 @@ export interface SuiSignAndExecuteTransactionOutput
   extends SuiTransactionResponse {}
 
 /** Options for signing and sending transactions. */
-export interface SuiSignAndExecuteTransactionOptions {}
+export interface SuiSignAndExecuteTransactionOptions {
+  requestType?: ExecuteTransactionRequestType;
+}