assertIsKeyPairSigner

function assertIsKeyPairSigner<TAddress, TValue>(
    value,
): asserts value is Readonly<{
    address: Address<TAddress>;
    signMessages: any;
}> &
    Readonly<{ address: Address<TAddress>; signTransactions: any }> & {
        keyPair: CryptoKeyPair;
    } & TValue;

Asserts that the provided value implements the KeyPairSigner interface.

Type Parameters

Type ParameterDescription
TAddress extends stringThe inferred type of the address provided.
TValue extends object-

Parameters

ParameterType
valueTValue

Returns

asserts value is Readonly<{ address: Address<TAddress>; signMessages: any }> & Readonly<{ address: Address<TAddress>; signTransactions: any }> & { keyPair: CryptoKeyPair } & TValue

Example

import { generateKeyPairSigner, assertIsKeyPairSigner } from '@solana/signers';
 
const signer = await generateKeyPairSigner();
assertIsKeyPairSigner(signer); // void
assertIsKeyPairSigner({ address: address('1234..5678') }); // Throws an error.

On this page