signTransaction

function signTransaction<TTransaction>(
    keyPairs,
    transaction,
): Promise<FullySignedTransaction & TTransaction>;

Given an array of CryptoKey objects which are private keys pertaining to addresses that are required to sign a transaction, this method will return a new signed transaction of type FullySignedTransaction.

This function will throw unless the resulting transaction is fully signed.

Type Parameters

Type Parameter
TTransaction extends Readonly<{ messageBytes: TransactionMessageBytes; signatures: SignaturesMap; }> & TransactionWithLifetime

Parameters

ParameterType
keyPairsCryptoKeyPair[]
transactionTTransaction

Returns

Promise<FullySignedTransaction & TTransaction>

Example

import { generateKeyPair } from '@solana/keys';
import { signTransaction } from '@solana/transactions';
 
const signedTransaction = await signTransaction([myPrivateKey], tx);

See

partiallySignTransaction if you want to sign the transaction without asserting that the resulting transaction is fully signed.

On this page