gill
Version:
a modern javascript/typescript client library for interacting with the Solana blockchain
39 lines • 1.9 kB
TypeScript
import type { KeyPairSigner } from "@solana/kit";
export declare function assertKeyPairIsExtractable(keyPair: CryptoKeyPair): asserts keyPair is ExtractableCryptoKeyPair;
type Extractable = {
"~extractable": true;
};
type ExtractableCryptoKeyPair = CryptoKeyPair & Extractable;
type ExtractableKeyPairSigner = KeyPairSigner & Extractable;
/**
* Generates an extractable Ed25519 `CryptoKeyPair` capable of signing messages and transactions
* */
export declare function generateExtractableKeyPair(): Promise<ExtractableCryptoKeyPair>;
/**
* Generates an extractable signer capable of signing messages and transactions using a Crypto KeyPair.
* */
export declare function generateExtractableKeyPairSigner(): Promise<ExtractableKeyPairSigner>;
/**
* Extracts the raw key material from an extractable Ed25519 CryptoKeyPair.
*
* @remarks
* - Requires a keypair generated with extractable=true. See {@link generateExtractableKeyPair}.
* - The extracted bytes can be used to reconstruct the `CryptoKeyPair` with {@link createKeyPairFromBytes}.
*
* @param keypair An extractable Ed25519 `CryptoKeyPair`
* @returns Raw key bytes as `Uint8Array`
*/
export declare function extractBytesFromKeyPair(keypair: ExtractableCryptoKeyPair | CryptoKeyPair): Promise<Uint8Array>;
/**
* Extracts the raw key material from an extractable Ed25519 KeyPairSigner.
*
* @remarks
* - Requires a keypair generated with extractable=true. See {@link generateExtractableKeyPairSigner}.
* - The extracted bytes can be used to reconstruct the `CryptoKeyPair` with {@link createKeyPairSignerFromBytes}.
*
* @param keypairSigner An extractable Ed25519 `KeyPairSigner`
* @returns Raw key bytes as `Uint8Array`
*/
export declare function extractBytesFromKeyPairSigner(keypairSigner: ExtractableKeyPairSigner | KeyPairSigner): Promise<Uint8Array>;
export {};
//# sourceMappingURL=keypairs-extractable.d.ts.map