ssv-keys/dist/tsc/src/lib/SSVKeys.d.ts

Tool for splitting a validator key into a predefined threshold of shares via Shamir-Secret-Sharing (SSS), and encrypt them with a set of operator keys.

import { IShares, ISharesKeyPairs } from './Threshold';
import { EncryptShare } from './Encryption/Encryption';
import { IOperator } from './KeyShares/KeySharesData/IOperator';
export interface ExtractedKeys {
    privateKey: string;
    publicKey: string;
}
interface ISharesValidation {
    shares: string;
    operatorsCount: number;
    validatorPublicKey: string;
    isAccountExists: boolean;
    ownerAddress: string;
    ownerNonce: number;
    blockNumber: number;
}
/**
 * SSVKeys class provides high-level methods to easily work with entire flow:
 *  - getting private key from keystore file using password
 *  - creating shares threshold
 *  - creating final shares
 *  - building final payload which is ready to be used in web3 transaction
 */
export declare class SSVKeys {
    static SHARES_FORMAT_ABI: string;
    protected threshold: ISharesKeyPairs | undefined;
    /**
     * Extract private key from keystore data using keystore password.
     * Generally can be used in browsers when the keystore data has been provided by browser.
     * @param data
     * @param password
     */
    extractKeys(data: string, password: string): Promise<ExtractedKeys>;
    /**
     * Build threshold using private key and list of operators.
     * @param privateKey
     * @param operators
     */
    createThreshold(privateKey: string, operators: IOperator[]): Promise<ISharesKeyPairs>;
    /**
     * Encrypt operators shares using operators list (id, publicKey).
     * @param operators
     * @param shares
     */
    encryptShares(operators: IOperator[], shares: IShares[]): Promise<EncryptShare[]>;
    /**
     * Build shares from private key, operators list
     * @param privateKey
     * @param operators
     */
    buildShares(privateKey: string, operators: IOperator[]): Promise<EncryptShare[]>;
    /**
     * Getting threshold if it has been created before.
     */
    getThreshold(): ISharesKeyPairs | undefined;
    validateSharesPostRegistration({ shares, operatorsCount, validatorPublicKey, isAccountExists, ownerAddress, ownerNonce, blockNumber }: ISharesValidation): Promise<{
        isValid: boolean;
        isSharesValid: boolean;
        sharesPublicKeys: any;
        encryptedKeys: any;
        memo: {
            message: string;
            error: string;
            data: string;
            blockNumber: number;
        }[];
    }>;
}
export {};