@mysten/wallet-standard/src/features/suiSignTransaction.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 { IdentifierString, WalletAccount } from '@wallet-standard/core';

/** Name of the feature. */
export const SuiSignTransaction = 'sui:signTransaction';

/** The latest API version of the signTransaction API. */
export type SuiSignTransactionVersion = '2.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. */
	[SuiSignTransaction]: {
		/** Version of the feature API. */
		version: SuiSignTransactionVersion;
		signTransaction: SuiSignTransactionMethod;
	};
};

export type SuiSignTransactionMethod = (
	input: SuiSignTransactionInput,
) => Promise<SignedTransaction>;

/** Input for signing transactions. */
export interface SuiSignTransactionInput {
	transaction: { toJSON: () => Promise<string> };
	account: WalletAccount;
	chain: IdentifierString;
	signal?: AbortSignal;
}

/** Output of signing transactions. */

export interface SignedTransaction {
	/** Transaction as base64 encoded bcs. */
	bytes: string;
	/** Base64 encoded signature */
	signature: string;
}