signOffchainMessageWithSigners

function signOffchainMessageWithSigners(
    offchainMessage,
    config?,
): Promise<
    FullySignedOffchainMessageEnvelope & OffchainMessageEnvelope
>;

Extracts all MessageSigners inside the provided offchain message and uses them to return a signed offchain message envelope before asserting that all signatures required by the message are present.

This function delegates to the partiallySignOffchainMessageWithSigners function in order to extract signers from the offchain message and sign it.

Parameters

ParameterType
offchainMessageOffchainMessageWithRequiredSignatories< | Readonly<{ address: Address<string>; }> | OffchainMessageSignatorySigner> & Omit<OffchainMessage, "requiredSignatories">
config?Readonly<{ abortSignal?: AbortSignal; }>

Returns

Promise<FullySignedOffchainMessageEnvelope & OffchainMessageEnvelope>

Example

const mySignedOffchainMessageEnvelope = await signOffchainMessageWithSigners(myOffchainMessage);
 
// With additional config.
const mySignedOffchainMessageEnvelope = await signOffchainMessageWithSigners(myOffchainMessage, {
    abortSignal: myAbortController.signal,
});
 
// We now know the offchain message is fully signed.
mySignedOffchainMessageEnvelope satisfies FullySignedOffchainMessageEnvelope;

See

partiallySignOffchainMessageWithSigners

On this page