@mysten/wallet-standard/src/features/suiSignAndExecuteTransactionBlock.ts

A suite of standard utilities for implementing wallets based on the Wallet Standard.

// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

import type {
	ExecuteTransactionRequestType,
	SuiTransactionBlockResponse,
	SuiTransactionBlockResponseOptions,
} from '@mysten/sui/client';

import type { SuiSignTransactionBlockInput } from './suiSignTransactionBlock.js';

/** Name of the feature. */
export const SuiSignAndExecuteTransactionBlock = 'sui:signAndExecuteTransactionBlock';

/** The latest API version of the signAndExecuteTransactionBlock API. */
export type SuiSignAndExecuteTransactionBlockVersion = '1.0.0';

/**
 * @deprecated Use `sui:signAndExecuteTransaction` instead.
 *
 * 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. */
	[SuiSignAndExecuteTransactionBlock]: {
		/** Version of the feature API. */
		version: SuiSignAndExecuteTransactionBlockVersion;
		/** @deprecated Use `sui:signAndExecuteTransaction` instead. */
		signAndExecuteTransactionBlock: SuiSignAndExecuteTransactionBlockMethod;
	};
};

/** @deprecated Use `sui:signAndExecuteTransaction` instead. */
export type SuiSignAndExecuteTransactionBlockMethod = (
	input: SuiSignAndExecuteTransactionBlockInput,
) => Promise<SuiSignAndExecuteTransactionBlockOutput>;

/** Input for signing and sending transactions. */
export interface SuiSignAndExecuteTransactionBlockInput extends SuiSignTransactionBlockInput {
	/**
	 * @deprecated requestType will be ignored by JSON RPC in the future
	 */
	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 {}