@bitgo-beta/sdk-core 8.2.1-beta.99 → 8.2.1-beta.991

package/dist/src/bitgo/utils/tss/ecdsa/ecdsaMPCv2.d.ts

@@ -0,0 +1,199 @@
+import { DklsTypes } from '@bitgo-beta/sdk-lib-mpc';
+import { Buffer } from 'buffer';
+import { KeychainsTriplet } from '../../../baseCoin';
+import { MPCv2BroadcastMessage, MPCv2KeyGenRound1Response, MPCv2KeyGenRound2Response, MPCv2KeyGenRound3Response, MPCv2P2PMessage, MPCv2PartyFromStringOrNumber } from '@bitgo/public-types';
+import { Ecdsa } from '../../../../account-lib';
+import { Keychain } from '../../../keychain';
+import { DecryptedRetrofitPayload } from '../../../keychain/iKeychains';
+import { MPCv2PartiesEnum } from './typesMPCv2';
+import { CustomMPCv2SigningRound1GeneratingFunction, CustomMPCv2SigningRound2GeneratingFunction, CustomMPCv2SigningRound3GeneratingFunction, RequestType, SignatureShareRecord, TSSParams, TSSParamsForMessage, TSSParamsForMessageWithPrv, TSSParamsWithPrv, TxRequest } from '../baseTypes';
+import { BaseEcdsaUtils } from './base';
+import { EcdsaMPCv2KeyGenSendFn } from './ecdsaMPCv2KeyGenSender';
+export declare class EcdsaMPCv2Utils extends BaseEcdsaUtils {
+    /** @inheritdoc */
+    createKeychains(params: {
+        passphrase: string;
+        enterprise: string;
+        originalPasscodeEncryptionCode?: string;
+        retrofit?: DecryptedRetrofitPayload;
+    }): Promise<KeychainsTriplet>;
+    createParticipantKeychain(participantIndex: MPCv2PartyFromStringOrNumber, commonKeychain: string, privateMaterial?: Buffer, reducedPrivateMaterial?: Buffer, passphrase?: string, originalPasscodeEncryptionCode?: string): Promise<Keychain>;
+    /**
+     * Converts a User or Backup MPCv1 SigningMaterial to RetrofitData needed by MPCv2 DKG.
+     *
+     * @param decryptedKeyshare - MPCv1 decrypted signing material for user or backup as a json.stringify string and bitgo's Big Si.
+     * @param partyId - The party ID of the MPCv1 keyshare.
+     * @returns The retrofit data needed to start an MPCv2 DKG session.
+     * @deprecated
+     */
+    static getKeyDataForRetrofit(decryptedKeyshare: string, partyId: MPCv2PartiesEnum.BACKUP | MPCv2PartiesEnum.USER): DklsTypes.RetrofitData;
+    /**
+     * Converts user and backup MPCv1 SigningMaterial to RetrofitData needed by MPCv2 DKG.
+     *
+     * @param {Object} params - MPCv1 decrypted signing material for user and backup as a json.stringify string and bitgo's Big Si.
+     * @returns {{ mpcv2UserKeyShare: DklsTypes.RetrofitData; mpcv2BakcupKeyShare: DklsTypes.RetrofitData }} - the retrofit data needed to start an MPCv2 DKG session.
+     */
+    getMpcV2RetrofitDataFromMpcV1Keys(params: {
+        mpcv1UserKeyShare: string;
+        mpcv1BackupKeyShare: string;
+    }): {
+        mpcv2UserKeyShare: DklsTypes.RetrofitData;
+        mpcv2BackupKeyShare: DklsTypes.RetrofitData;
+    };
+    /**
+     * Get retrofit data from MPCv1 key share.
+     * @param mpcv1PartyKeyShare
+     * @param mpcv1PartyIndex
+     * @param xiList
+     * @param mpc
+     * @deprecated
+     */
+    static getMpcV2RetrofitDataFromMpcV1Key({ mpcv1PartyKeyShare, mpcv1PartyIndex, xiList, mpc, }: {
+        mpcv1PartyKeyShare: string;
+        mpcv1PartyIndex: number;
+        xiList: number[][];
+        mpc: Ecdsa;
+    }): DklsTypes.RetrofitData;
+    private addUserKeychain;
+    private addBackupKeychain;
+    private getUserAndBackupSession;
+    private addBitgoKeychain;
+    sendKeyGenerationRound1(enterprise: string, userGpgPublicKey: string, backupGpgPublicKey: string, payload: DklsTypes.AuthEncMessages & {
+        walletId?: string;
+    }): Promise<MPCv2KeyGenRound1Response>;
+    sendKeyGenerationRound2(enterprise: string, sessionId: string, payload: DklsTypes.AuthEncMessages): Promise<MPCv2KeyGenRound2Response>;
+    sendKeyGenerationRound3(enterprise: string, sessionId: string, payload: DklsTypes.AuthEncMessages): Promise<MPCv2KeyGenRound3Response>;
+    sendKeyGenerationRound1BySender(senderFn: EcdsaMPCv2KeyGenSendFn<MPCv2KeyGenRound1Response>, userGpgPublicKey: string, backupGpgPublicKey: string, payload: DklsTypes.AuthEncMessages & {
+        walletId?: string;
+    }): Promise<MPCv2KeyGenRound1Response>;
+    sendKeyGenerationRound2BySender(senderFn: EcdsaMPCv2KeyGenSendFn<MPCv2KeyGenRound2Response>, sessionId: string, payload: DklsTypes.AuthEncMessages): Promise<MPCv2KeyGenRound2Response>;
+    sendKeyGenerationRound3BySender(senderFn: EcdsaMPCv2KeyGenSendFn<MPCv2KeyGenRound3Response>, sessionId: string, payload: DklsTypes.AuthEncMessages): Promise<MPCv2KeyGenRound3Response>;
+    /**
+     * Signs the transaction associated to the transaction request.
+     * @param {string | TxRequest} params.txRequest - transaction request object or id
+     * @param {string} params.prv - decrypted private key
+     * @param {string} params.reqId - request id
+     * @param {string} params.mpcv2PartyId - party id for the signer involved in this mpcv2 request (either 0 for user or 1 for backup)
+     * @returns {Promise<TxRequest>} fully signed TxRequest object
+     */
+    signTxRequest(params: TSSParamsWithPrv): Promise<TxRequest>;
+    /**
+     * Signs the message associated to the transaction request.
+     * @param {string | TxRequest} params.txRequest - transaction request object or id
+     * @param {string} params.prv - decrypted private key
+     * @param {string} params.reqId - request id
+     * @returns {Promise<TxRequest>} fully signed TxRequest object
+     */
+    signTxRequestForMessage(params: TSSParamsForMessageWithPrv): Promise<TxRequest>;
+    private signRequestBase;
+    formatBitgoBroadcastMessage(broadcastMessage: MPCv2BroadcastMessage): {
+        from: 0 | 1 | 2;
+        payload: {
+            message: string;
+            signature: string;
+        };
+    };
+    formatP2PMessage(p2pMessage: MPCv2P2PMessage, commitment?: string): {
+        payload: {
+            encryptedMessage: string;
+            signature: string;
+        };
+        from: 0 | 1 | 2;
+        to: 0 | 1 | 2;
+        commitment: string | undefined;
+    };
+    /**
+     * Get the hash string and derivation path from the transaction request.
+     * @param {TxRequest} txRequest - the transaction request object
+     * @param {RequestType} requestType - the request type
+     * @returns {{ hashBuffer: Buffer; derivationPath: string }} - the hash string and derivation path
+     */
+    private getHashStringAndDerivationPath;
+    /**
+     * Gets the BitGo and user GPG keys from the BitGo public GPG key and the encrypted user GPG private key.
+     * @param {string} bitgoPublicGpgKey  - the BitGo public GPG key
+     * @param {string} encryptedUserGpgPrvKey  - the encrypted user GPG private key
+     * @param {string} walletPassphrase  - the wallet passphrase
+     * @returns {Promise<{ bitgoGpgKey: pgp.Key; userGpgKey: pgp.SerializedKeyPair<string> }>} - the BitGo and user GPG keys
+     */
+    private getBitgoAndUserGpgKeys;
+    /**
+     * Validates the adata and cyphertext.
+     * @param adata string
+     * @param cyphertext string
+     * @returns void
+     * @throws {Error} if the adata or cyphertext is invalid
+     */
+    private validateAdata;
+    /** @inheritdoc */
+    signEcdsaMPCv2TssUsingExternalSigner(params: TSSParams | TSSParamsForMessage, externalSignerMPCv2SigningRound1Generator: CustomMPCv2SigningRound1GeneratingFunction, externalSignerMPCv2SigningRound2Generator: CustomMPCv2SigningRound2GeneratingFunction, externalSignerMPCv2SigningRound3Generator: CustomMPCv2SigningRound3GeneratingFunction, requestType?: RequestType): Promise<TxRequest>;
+    createOfflineRound1Share(params: {
+        txRequest: TxRequest;
+        prv: string;
+        walletPassphrase: string;
+    }): Promise<{
+        signatureShareRound1: SignatureShareRecord;
+        userGpgPubKey: string;
+        encryptedRound1Session: string;
+        encryptedUserGpgPrvKey: string;
+    }>;
+    createOfflineRound2Share(params: {
+        txRequest: TxRequest;
+        prv: string;
+        walletPassphrase: string;
+        bitgoPublicGpgKey: string;
+        encryptedUserGpgPrvKey: string;
+        encryptedRound1Session: string;
+    }): Promise<{
+        signatureShareRound2: SignatureShareRecord;
+        encryptedRound2Session: string;
+    }>;
+    createOfflineRound3Share(params: {
+        txRequest: TxRequest;
+        prv: string;
+        walletPassphrase: string;
+        bitgoPublicGpgKey: string;
+        encryptedUserGpgPrvKey: string;
+        encryptedRound2Session: string;
+    }): Promise<{
+        signatureShareRound3: SignatureShareRecord;
+    }>;
+}
+/**
+ * Checks if the given key share, when decrypted, contains valid GG18 signing material.
+ *
+ * @param {string} keyShare - The encrypted key share string.
+ * @param {string|undefined} walletPassphrase - The passphrase used to decrypt the key share
+ * @returns {boolean} - Returns `true` if the decrypted data contains valid signing material, otherwise `false`.
+ */
+export declare function isGG18SigningMaterial(keyShare: string, walletPassphrase: string | undefined): boolean;
+/**
+ * Get the MPC v2 recovery key shares from the provided user and backup key shares.
+ * @param encryptedUserKey encrypted gg18 or MPCv2 user key
+ * @param encryptedBackupKey encrypted gg18 or MPCv2 backup key
+ * @param walletPassphrase password for user and backup key
+ * @returns MPC v2 recovery key shares
+ */
+export declare function getMpcV2RecoveryKeyShares(encryptedUserKey: string, encryptedBackupKey: string, walletPassphrase?: string): Promise<{
+    userKeyShare: Buffer;
+    backupKeyShare: Buffer;
+    commonKeyChain: string;
+}>;
+/**
+ * Signs a message hash using MPC v2 recovery key shares.
+ *
+ * @param {Buffer} messageHash
+ * @param {Buffer} userKeyShare
+ * @param {Buffer} backupKeyShare
+ * @param {string} commonKeyChain
+ * @returns {Promise<{ recid: number, r: string, s: string, y: string }>}
+ *
+ * @async
+ */
+export declare function signRecoveryMpcV2(messageHash: Buffer, userKeyShare: Buffer, backupKeyShare: Buffer, commonKeyChain: string): Promise<{
+    recid: number;
+    r: string;
+    s: string;
+    y: string;
+}>;
+//# sourceMappingURL=ecdsaMPCv2.d.ts.map

package/dist/src/bitgo/utils/tss/ecdsa/ecdsaMPCv2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecdsaMPCv2.d.ts","sourceRoot":"","sources":["../../../../../../src/bitgo/utils/tss/ecdsa/ecdsaMPCv2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiD,SAAS,EAAa,MAAM,yBAAyB,CAAC;AAG9G,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAKhC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EAEzB,eAAe,EACf,4BAA4B,EAG7B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChD,OAAO,EAAsB,QAAQ,EAAW,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAGxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAUhD,OAAO,EACL,0CAA0C,EAC1C,0CAA0C,EAC1C,0CAA0C,EAC1C,WAAW,EACX,oBAAoB,EACpB,SAAS,EACT,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAChB,SAAS,EACV,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAA6B,MAAM,0BAA0B,CAAC;AAG7F,qBAAa,eAAgB,SAAQ,cAAc;IACjD,kBAAkB;IACZ,eAAe,CAAC,MAAM,EAAE;QAC5B,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;KACrC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8RvB,yBAAyB,CAC7B,gBAAgB,EAAE,4BAA4B,EAC9C,cAAc,EAAE,MAAM,EACtB,eAAe,CAAC,EAAE,MAAM,EACxB,sBAAsB,CAAC,EAAE,MAAM,EAC/B,UAAU,CAAC,EAAE,MAAM,EACnB,8BAA8B,CAAC,EAAE,MAAM,GACtC,OAAO,CAAC,QAAQ,CAAC;IA0CpB;;;;;;;OAOG;IACH,MAAM,CAAC,qBAAqB,CAC1B,iBAAiB,EAAE,MAAM,EACzB,OAAO,EAAE,gBAAgB,CAAC,MAAM,GAAG,gBAAgB,CAAC,IAAI,GACvD,SAAS,CAAC,YAAY;IAezB;;;;;OAKG;IACH,iCAAiC,CAAC,MAAM,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAC;QAAC,mBAAmB,EAAE,MAAM,CAAA;KAAE,GAAG;QACrG,iBAAiB,EAAE,SAAS,CAAC,YAAY,CAAC;QAC1C,mBAAmB,EAAE,SAAS,CAAC,YAAY,CAAC;KAC7C;IAuBD;;;;;;;OAOG;IACH,MAAM,CAAC,gCAAgC,CAAC,EACtC,kBAAkB,EAClB,eAAe,EACf,MAAM,EACN,GAAG,GACJ,EAAE;QACD,kBAAkB,EAAE,MAAM,CAAC;QAC3B,eAAe,EAAE,MAAM,CAAC;QACxB,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;QACnB,GAAG,EAAE,KAAK,CAAC;KACZ,GAAG,SAAS,CAAC,YAAY;YAkCZ,eAAe;YAiBf,iBAAiB;IAiB/B,OAAO,CAAC,uBAAuB;YAmBjB,gBAAgB;IAKxB,uBAAuB,CAC3B,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,SAAS,CAAC,eAAe,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GACzD,OAAO,CAAC,yBAAyB,CAAC;IAS/B,uBAAuB,CAC3B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,SAAS,CAAC,eAAe,GACjC,OAAO,CAAC,yBAAyB,CAAC;IAI/B,uBAAuB,CAC3B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,SAAS,CAAC,eAAe,GACjC,OAAO,CAAC,yBAAyB,CAAC;IAI/B,+BAA+B,CACnC,QAAQ,EAAE,sBAAsB,CAAC,yBAAyB,CAAC,EAC3D,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,SAAS,CAAC,eAAe,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GACzD,OAAO,CAAC,yBAAyB,CAAC;IAiB/B,+BAA+B,CACnC,QAAQ,EAAE,sBAAsB,CAAC,yBAAyB,CAAC,EAC3D,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,SAAS,CAAC,eAAe,GACjC,OAAO,CAAC,yBAAyB,CAAC;IAkC/B,+BAA+B,CACnC,QAAQ,EAAE,sBAAsB,CAAC,yBAAyB,CAAC,EAC3D,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,SAAS,CAAC,eAAe,GACjC,OAAO,CAAC,yBAAyB,CAAC;IA4BrC;;;;;;;OAOG;IAEG,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAKjE;;;;;;OAMG;IACG,uBAAuB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,SAAS,CAAC;YAKvE,eAAe;IAmM7B,2BAA2B,CAAC,gBAAgB,EAAE,qBAAqB;;;;;;;IAOnE,gBAAgB,CAAC,UAAU,EAAE,eAAe,EAAE,UAAU,CAAC,EAAE,MAAM;;;;;;;;;IAWjE;;;;;OAKG;IACH,OAAO,CAAC,8BAA8B;IA4BtC;;;;;;OAMG;YACW,sBAAsB;IAsBpC;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAgBrB,kBAAkB;IACZ,oCAAoC,CACxC,MAAM,EAAE,SAAS,GAAG,mBAAmB,EACvC,yCAAyC,EAAE,0CAA0C,EACrF,yCAAyC,EAAE,0CAA0C,EACrF,yCAAyC,EAAE,0CAA0C,EACrF,WAAW,GAAE,WAA4B,GACxC,OAAO,CAAC,SAAS,CAAC;IAyFf,wBAAwB,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAC/G,oBAAoB,EAAE,oBAAoB,CAAC;QAC3C,aAAa,EAAE,MAAM,CAAC;QACtB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IAwBI,wBAAwB,CAAC,MAAM,EAAE;QACrC,SAAS,EAAE,SAAS,CAAC;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,MAAM,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sBAAsB,EAAE,MAAM,CAAC;KAChC,GAAG,OAAO,CAAC;QACV,oBAAoB,EAAE,oBAAoB,CAAC;QAC3C,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IAyDI,wBAAwB,CAAC,MAAM,EAAE;QACrC,SAAS,EAAE,SAAS,CAAC;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,MAAM,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sBAAsB,EAAE,MAAM,CAAC;KAChC,GAAG,OAAO,CAAC;QACV,oBAAoB,EAAE,oBAAoB,CAAC;KAC5C,CAAC;CAiDH;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAYrG;AAED;;;;;;GAMG;AACH,wBAAsB,yBAAyB,CAC7C,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,MAAM,EAC1B,gBAAgB,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC;IACT,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC,CAKD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CACrC,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC;IACT,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC,CAoBD"}