@stellar/stellar-sdk/lib/esm/base/keypair.d.ts

A library for working with the Stellar network, including communication with the Horizon and Soroban RPC servers.

import xdr from "./xdr.js";
/**
 * `Keypair` represents public (and secret) keys of the account.
 *
 * Currently `Keypair` only supports ed25519 but in a future this class can be abstraction layer for other
 * public-key signature systems.
 *
 * Use more convenient methods to create `Keypair` object:
 * * `{@link Keypair.fromPublicKey}`
 * * `{@link Keypair.fromSecret}`
 * * `{@link Keypair.random}`
 */
export declare class Keypair {
    readonly type: "ed25519";
    private _publicKey;
    private _secretSeed?;
    private _secretKey?;
    /**
     * @param keys - at least one of keys must be provided.
     *   - `type`: public-key signature system name (currently only `ed25519` keys are supported)
     *   - `publicKey`: raw public key
     *   - `secretKey`: raw secret key (32-byte secret seed in ed25519)
     */
    constructor(keys: {
        type: "ed25519";
        secretKey: Buffer | string;
        publicKey?: Buffer | string;
    } | {
        type: "ed25519";
        publicKey: Buffer | string;
    });
    /**
     * Creates a new `Keypair` instance from secret. This can either be secret key or secret seed depending
     * on underlying public-key signature system. Currently `Keypair` only supports ed25519.
     * @param secret - secret key (ex. `SDAK....`)
     */
    static fromSecret(secret: string): Keypair;
    /**
     * Creates a new `Keypair` object from ed25519 secret key seed raw bytes.
     *
     * @param rawSeed - raw 32-byte ed25519 secret key seed
     */
    static fromRawEd25519Seed(rawSeed: Buffer): Keypair;
    /**
     * Returns `Keypair` object representing network master key.
     * @param networkPassphrase - passphrase of the target stellar network (e.g. "Public Global Stellar Network ; September 2015")
     */
    static master(networkPassphrase: string): Keypair;
    /**
     * Creates a new `Keypair` object from public key.
     * @param publicKey - public key (ex. `GB3KJPLFUYN5VL6R3GU3EGCGVCKFDSD7BEDX42HWG5BWFKB3KQGJJRMA`)
     */
    static fromPublicKey(publicKey: string): Keypair;
    /**
     * Create a random `Keypair` object.
     */
    static random(): Keypair;
    /** Returns this public key as an xdr.AccountId. */
    xdrAccountId(): xdr.AccountId;
    /** Returns this public key as an xdr.PublicKey. */
    xdrPublicKey(): xdr.PublicKey;
    /**
     * Creates a {@link xdr.MuxedAccount} object from the public key.
     *
     * You will get a different type of muxed account depending on whether or not
     * you pass an ID.
     *
     * @param id - (optional) stringified integer indicating the underlying muxed
     *     ID of the new account object
     */
    xdrMuxedAccount(id?: string): xdr.MuxedAccount;
    /**
     * Returns raw public key bytes
     */
    rawPublicKey(): Buffer;
    /**
     * Returns the signature hint for this keypair.
     * The hint is the last 4 bytes of the account ID XDR representation.
     */
    signatureHint(): Buffer;
    /**
     * Returns public key associated with this `Keypair` object.
     */
    publicKey(): string;
    /**
     * Returns secret key associated with this `Keypair` object.
     *
     * The secret key is encoded in Stellar format (e.g., `SDAK....`).
     *
     * @throws if no secret key is available
     */
    secret(): string;
    /**
     * Returns raw secret key bytes.
     *
     * @throws if no secret seed is available
     */
    rawSecretKey(): Buffer;
    /**
     * Returns `true` if this `Keypair` object contains secret key and can sign.
     */
    canSign(): boolean;
    /**
     * Signs data.
     *
     * @param data - data to sign
     * @throws if no secret key is available
     */
    sign(data: Buffer): Buffer;
    /**
     * Verifies if `signature` for `data` is valid.
     *
     * @param data - signed data
     * @param signature - signature to verify
     */
    verify(data: Buffer, signature: Buffer): boolean;
    /**
     * Signs an arbitrary message per SEP-53.
     *
     * The message is UTF-8 encoded (if a string), prefixed with the fixed
     * `"Stellar Signed Message:\n"` marker, hashed with SHA-256, and that hash is
     * signed with this keypair's ed25519 secret key.
     *
     * @param message - the message to sign (a UTF-8 string or raw bytes)
     * @returns the 64-byte ed25519 signature
     * @throws if no secret key is available
     * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0053.md
     */
    signMessage(message: string | Buffer): Buffer;
    /**
     * Verifies a SEP-53 signed message against this keypair's public key.
     *
     * @param message - the original message (a UTF-8 string or raw bytes)
     * @param signature - the 64-byte signature to verify
     * @returns `true` if `signature` is valid for `message` and this key
     * @see https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0053.md
     */
    verifyMessage(message: string | Buffer, signature: Buffer): boolean;
    /**
     * Computes the SEP-53 message hash:
     * `SHA-256("Stellar Signed Message:\n" + message)`.
     */
    private _hashMessage;
    /**
     * Returns the decorated signature (hint+sig) for arbitrary data.
     *
     * The returned structure can be added directly to a transaction envelope.
     *
     * @param data - arbitrary data to sign
     *
     * @see TransactionBase.addDecoratedSignature
     */
    signDecorated(data: Buffer): xdr.DecoratedSignature;
    /**
     * Returns the raw decorated signature (hint+sig) for a signed payload signer.
     *
     *  The hint is defined as the last 4 bytes of the signer key XORed with last
     *  4 bytes of the payload (zero-left-padded if necessary).
     *
     * @param data - data to both sign and treat as the payload
     *
     * @see https://github.com/stellar/stellar-protocol/blob/master/core/cap-0040.md#signature-hint
     * @see TransactionBase.addDecoratedSignature
     */
    signPayloadDecorated(data: Buffer): xdr.DecoratedSignature;
}