feat: passing the custom outputs to signAndExecuteTransaction

suiet · Jun 17, 2024 · 4d2c989 · 4d2c989
1 parent 24d020a
commit 4d2c989
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 32 deletions.
diff --git a/packages/kit/src/components/WalletProvider.tsx b/packages/kit/src/components/WalletProvider.tsx
@@ -41,14 +41,14 @@ import {
   WalletEvent,
   WalletEventListeners,
 } from "@suiet/wallet-sdk";
-import { SuiReportTransactionEffectsMethod } from "@mysten/wallet-standard/dist/esm";
 import {
   ExecuteTransactionOptions,
   ExecuteTransactionResult,
 } from "../types/params";
 import { SuiClient } from "@mysten/sui/client";
 import { toB64 } from "@mysten/sui/utils";
 import { SuiClientContext } from "../contexts/SuiClientContext";
+import { SuiSignAndExecuteTransactionOutput } from "@mysten/wallet-standard";
 
 export type WalletProviderProps = Extendable & {
   defaultWallets?: IDefaultWallet[];
@@ -279,10 +279,10 @@ export const WalletProvider = (props: WalletProviderProps) => {
   );
 
   const signAndExecuteTransaction = useCallback(
-    async (
+    async <Output extends SuiSignAndExecuteTransactionOutput>(
       input: Omit<SuiSignAndExecuteTransactionInput, "account" | "chain">,
       options?: ExecuteTransactionOptions
-    ) => {
+    ): Promise<Output> => {
       const [_wallet, account] = safelyGetWalletAndAccount();
 
       const executeTransaction = async (
@@ -291,32 +291,31 @@ export const WalletProvider = (props: WalletProviderProps) => {
         if (typeof options?.execute === "function") {
           return await options.execute(signedTransaction);
         }
-        const { digest, rawEffects } = await suiClient.executeTransactionBlock({
+        // by default, we only return the digest and rawEffects
+        return await suiClient.executeTransactionBlock({
           transactionBlock: signedTransaction.bytes,
           signature: signedTransaction.signature,
           options: {
             showRawEffects: true,
           },
         });
-        return {
-          digest,
-          rawEffects,
-        };
       };
 
       const signedTransaction = await _wallet.signTransaction({
         transaction: input.transaction,
         account,
         chain: chain.id as IdentifierString,
       });
-      const execResult = await executeTransaction(signedTransaction);
+      const { digest, effects, ...res } = await executeTransaction(
+        signedTransaction
+      );
 
-      let effects: string;
+      let effectsB64: string;
 
-      if ("effects" in execResult && execResult.effects?.bcs) {
-        effects = execResult.effects.bcs;
-      } else if ("rawEffects" in execResult) {
-        effects = toB64(new Uint8Array(execResult.rawEffects!));
+      if (effects && "bcs" in (effects as any)) {
+        effectsB64 = (effects as any)?.bcs;
+      } else if (res && (("rawEffects" in res) as any)) {
+        effectsB64 = toB64(new Uint8Array((res as any).rawEffects));
       } else {
         throw new Error(
           "effects or rawEffects not found in the execution result"
@@ -325,7 +324,7 @@ export const WalletProvider = (props: WalletProviderProps) => {
 
       try {
         await _wallet.reportTransactionEffects({
-          effects,
+          effects: effectsB64,
           account,
           chain: chain.id as IdentifierString,
         });
@@ -336,9 +335,10 @@ export const WalletProvider = (props: WalletProviderProps) => {
       return {
         bytes: signedTransaction.bytes,
         signature: signedTransaction.signature,
-        digest: execResult.digest,
-        effects,
-      };
+        digest: digest,
+        effects: effectsB64,
+        ...res,
+      } as Output;
     },
     [safelyGetWalletAndAccount, chain, suiClient]
   );

diff --git a/packages/kit/src/hooks/useWallet.ts b/packages/kit/src/hooks/useWallet.ts
@@ -24,7 +24,10 @@ import {
   WalletAccount,
   SignedTransaction,
 } from "@mysten/wallet-standard";
-import { ExecuteTransactionOptions } from "../types/params";
+import {
+  ExecuteTransactionOptions,
+  ExecuteTransactionResult,
+} from "../types/params";
 
 export interface WalletContextState {
   configuredWallets: IWallet[];
@@ -43,10 +46,10 @@ export interface WalletContextState {
   disconnect: () => Promise<void>;
   getAccounts: () => readonly WalletAccount[];
 
-  signAndExecuteTransaction(
+  signAndExecuteTransaction<Output extends SuiSignAndExecuteTransactionOutput>(
     input: Omit<SuiSignAndExecuteTransactionInput, "account" | "chain">,
     options?: ExecuteTransactionOptions
-  ): Promise<SuiSignAndExecuteTransactionOutput>;
+  ): Promise<Output>;
 
   signTransaction(
     input: Omit<SuiSignTransactionInput, "account" | "chain">

diff --git a/packages/kit/src/types/params.ts b/packages/kit/src/types/params.ts
@@ -1,16 +1,20 @@
-import { SignedTransaction } from "@mysten/wallet-standard";
+import { SuiTransactionBlockResponse } from "@mysten/sui/client";
+import {
+  SignedTransaction,
+  SuiSignAndExecuteTransactionOutput,
+} from "@mysten/wallet-standard";
+
+export type RpcClientExecuteTransactionResult = SuiTransactionBlockResponse;
+export type GraphQLClientExecuteTransactionResult = {
+  digest: string;
+  effects?: {
+    bcs?: string;
+  };
+};
 
 export type ExecuteTransactionResult =
-  | {
-      digest: string;
-      rawEffects?: number[];
-    }
-  | {
-      digest: string;
-      effects?: {
-        bcs?: string;
-      };
-    };
+  | RpcClientExecuteTransactionResult
+  | GraphQLClientExecuteTransactionResult;
 
 export type ExecuteTransactionOptions = {
   execute?: (