isFullySignedOffchainMessageEnvelope

function isFullySignedOffchainMessageEnvelope<TEnvelope>(
    offchainMessage,
): offchainMessage is FullySignedOffchainMessageEnvelope & TEnvelope;

A type guard that returns true if the input OffchainMessageEnvelope is fully signed, and refines its type for use in your program, adding the FullySignedOffchainMessageEnvelope type.

Type Parameters

Type Parameter
TEnvelope extends OffchainMessageEnvelope

Parameters

ParameterType
offchainMessageTEnvelope

Returns

offchainMessage is FullySignedOffchainMessageEnvelope & TEnvelope

Example

import { isFullySignedOffchainMessageEnvelope } from '@solana/offchain-messages';
 
const offchainMessageEnvelope = getOffchainMessageDecoder().decode(offchainMessageBytes);
if (isFullySignedOffchainMessageEnvelope(offchainMessageEnvelope)) {
  // At this point we know that the offchain message is fully signed.
}

On this page