@bitgo-beta/sdk-core 8.2.1-beta.192 → 8.2.1-beta.1921

package/dist/src/bitgo/utils/tss/eddsa/eddsaMPCv2.d.ts

@@ -0,0 +1,156 @@
+import { EddsaMPCv2KeyGenRound1Request, EddsaMPCv2KeyGenRound1Response, EddsaMPCv2KeyGenRound2Request, EddsaMPCv2KeyGenRound2Response, MPCv2PartyFromStringOrNumber } from '@bitgo/public-types';
+import { EddsaMPCv2KeyGenCallbacks } from '../../../wallet/iWallets';
+import { MPSTypes } from '@bitgo-beta/sdk-lib-mpc';
+import { KeychainsTriplet } from '../../../baseCoin';
+import { Keychain, WebauthnKeyEncryptionInfo } from '../../../keychain';
+import { MPCv2PartiesEnum } from '../ecdsa/typesMPCv2';
+import { CustomEddsaMPCv2SigningRound1GeneratingFunction, CustomEddsaMPCv2SigningRound2GeneratingFunction, CustomEddsaMPCv2SigningRound3GeneratingFunction, RequestType, SignatureShareRecord, TSSParams, TSSParamsForMessage, TSSParamsForMessageWithPrv, TSSParamsWithPrv, TxRequest } from '../baseTypes';
+import { EncryptionVersion } from '../../../../api';
+import { BitGoBase } from '../../../bitgoBase';
+import { BaseEddsaUtils } from './base';
+import { EddsaMPCv2KeyGenSendFn } from './eddsaMPCv2KeyGenSender';
+import { EddsaMPCv2RecoveryKeyShares } from './types';
+export declare class EddsaMPCv2Utils extends BaseEddsaUtils {
+    private static readonly MPS_DSG_SIGNING_USER_GPG_KEY;
+    private static readonly MPS_DSG_SIGNING_ROUND1_STATE;
+    private static readonly MPS_DSG_SIGNING_ROUND2_STATE;
+    private static readonly MPS_DKG_KEYGEN_ROUND1_STATE;
+    /** @inheritdoc */
+    createKeychains(params: {
+        passphrase: string;
+        enterprise: string;
+        originalPasscodeEncryptionCode?: string;
+        webauthnInfo?: WebauthnKeyEncryptionInfo;
+        encryptionVersion?: EncryptionVersion;
+        safeId?: string;
+    }): Promise<KeychainsTriplet>;
+    createKeychainsWithExternalSigner(params: {
+        enterprise: string;
+        callbacks: EddsaMPCv2KeyGenCallbacks;
+    }): Promise<KeychainsTriplet>;
+    createParticipantKeychain(participantIndex: MPCv2PartyFromStringOrNumber, commonKeychain: string, privateMaterial?: Buffer, reducedPrivateMaterial?: Buffer, passphrase?: string, originalPasscodeEncryptionCode?: string, webauthnInfo?: WebauthnKeyEncryptionInfo, encryptionVersion?: EncryptionVersion, enterprise?: string, safeId?: string): Promise<Keychain>;
+    private addUserKeychain;
+    private addBackupKeychain;
+    private addBitgoKeychain;
+    sendKeyGenerationRound1(enterprise: string, payload: EddsaMPCv2KeyGenRound1Request, safeId?: string): Promise<EddsaMPCv2KeyGenRound1Response>;
+    sendKeyGenerationRound1BySender(senderFn: EddsaMPCv2KeyGenSendFn<EddsaMPCv2KeyGenRound1Response>, payload: EddsaMPCv2KeyGenRound1Request): Promise<EddsaMPCv2KeyGenRound1Response>;
+    sendKeyGenerationRound2(enterprise: string, payload: EddsaMPCv2KeyGenRound2Request): Promise<EddsaMPCv2KeyGenRound2Response>;
+    sendKeyGenerationRound2BySender(senderFn: EddsaMPCv2KeyGenSendFn<EddsaMPCv2KeyGenRound2Response>, payload: EddsaMPCv2KeyGenRound2Request): Promise<EddsaMPCv2KeyGenRound2Response>;
+    /**
+     * Signs the transaction associated with 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
+     */
+    signTxRequest(params: TSSParamsWithPrv): Promise<TxRequest>;
+    /**
+     * Signs the message associated with 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
+     */
+    signTxRequestForMessage(params: TSSParamsForMessageWithPrv): Promise<TxRequest>;
+    /**
+     * Full 3-round EdDSA MPCv2 (MPS) online signing orchestration.
+     *
+     * Protocol overview:
+     *   WASM Round 0  → getFirstMessage()      (produces userMsg1)
+     *   API  Round 1  → send userMsg1 / recv bitgoMsg1
+     *   WASM Round 1  → handleIncomingMessages([userMsg1, bitgoMsg1])  (produces userMsg2)
+     *   API  Round 2  → send userMsg2 / recv bitgoMsg2
+     *   WASM Round 2  → handleIncomingMessages([userMsg2, bitgoMsg2])  (produces userMsg3)
+     *   API  Round 3  → send userMsg3 (WP finalises; no BitGo msg returned to client)
+     */
+    private signRequestBase;
+    createOfflineKeyGenRound1Share(params: {
+        walletPassphrase: string;
+        encryptedUserGpgPrvKey: string;
+        bitgoGpgPubKey: string;
+        counterPartyGpgPubKey: string;
+        partyId?: MPCv2PartiesEnum.USER | MPCv2PartiesEnum.BACKUP;
+    }): Promise<{
+        signedMsg1: MPSTypes.MPSSignedMessage;
+        encryptedRound1Session: string;
+    }>;
+    createOfflineRound1Share(params: {
+        txRequest: TxRequest;
+        prv: string;
+        walletPassphrase: string;
+        encryptedPrv?: string;
+    }): Promise<{
+        signatureShareRound1: SignatureShareRecord;
+        userGpgPubKey: string;
+        encryptedRound1Session: string;
+        encryptedUserGpgPrvKey: string;
+    }>;
+    createOfflineRound2Share(params: {
+        txRequest: TxRequest;
+        walletPassphrase: string;
+        bitgoPublicGpgKey: string;
+        encryptedUserGpgPrvKey: string;
+        encryptedRound1Session: string;
+    }): Promise<{
+        signatureShareRound2: SignatureShareRecord;
+        encryptedRound2Session: string;
+    }>;
+    createOfflineRound3Share(params: {
+        txRequest: TxRequest;
+        walletPassphrase: string;
+        bitgoPublicGpgKey: string;
+        encryptedUserGpgPrvKey: string;
+        encryptedRound2Session: string;
+    }): Promise<{
+        signatureShareRound3: SignatureShareRecord;
+    }>;
+    /** @inheritdoc */
+    signEddsaMPCv2TssUsingExternalSigner(params: TSSParams | TSSParamsForMessage, externalSignerEddsaMPCv2SigningRound1Generator: CustomEddsaMPCv2SigningRound1GeneratingFunction, externalSignerEddsaMPCv2SigningRound2Generator: CustomEddsaMPCv2SigningRound2GeneratingFunction, externalSignerEddsaMPCv2SigningRound3Generator: CustomEddsaMPCv2SigningRound3GeneratingFunction, requestType?: RequestType): Promise<TxRequest>;
+}
+/**
+ * Detect whether an encrypted keycard contains MPCv1 signing material.
+ *
+ * Decrypts the keycard and checks for the JSON shape produced by the MPCv1 TSS
+ * key-generation flow (uShare.seed + bitgoYShare.u + backupYShare.u / userYShare.u).
+ * Returns false for MPCv2 CBOR keycards, wrong passwords, or any decryption error.
+ *
+ * @param encryptedKeyShare encrypted user or backup keycard
+ * @param walletPassphrase passphrase used to encrypt the keycard
+ * @param bitgo optional BitGoBase instance; when provided, decrypts via
+ *   bitgo.decrypt (supports both v1 SJCL and v2 Argon2id envelopes);
+ *   when absent, falls back to sjcl.decrypt (v1 only)
+ */
+export declare function isEddsaMpcV1SigningMaterial(encryptedKeyShare: string, walletPassphrase: string, bitgo?: BitGoBase): Promise<boolean>;
+/**
+ * Get EdDSA MPCv2 recovery key shares from encrypted reduced user and backup keys.
+ *
+ * The encrypted inputs are the `reducedEncryptedPrv` values stored on EdDSA MPCv2
+ * key cards. They decrypt to CBOR-encoded reduced shares that contain the opaque
+ * MPS signing key-share bytes plus the common public keychain material.
+ *
+ * @param encryptedUserKey encrypted EdDSA MPCv2 reduced user key
+ * @param encryptedBackupKey encrypted EdDSA MPCv2 reduced backup key
+ * @param walletPassphrase password for user and backup keys
+ * @returns EdDSA MPCv2 recovery key shares and common keychain
+ */
+export declare function getEddsaMpcV2RecoveryKeySharesFromReducedKey(encryptedUserKey: string, encryptedBackupKey: string, walletPassphrase?: string, bitgo?: BitGoBase): Promise<EddsaMPCv2RecoveryKeyShares>;
+/**
+ * Sign a message for recovery using EdDSA MPCv2 (MPS) with user and backup key shares.
+ *
+ * Runs the MPS DSG protocol locally to round 3, then verifies the resulting
+ * Ed25519 signature against the public key derived from the common keychain.
+ *
+ * @param message raw bytes to sign
+ * @param derivationPath BIP-32-style derivation path, e.g. `"m/0"`
+ * @param userKeyShare opaque MPS signing key-share bytes for the user party
+ * @param backupKeyShare opaque MPS signing key-share bytes for the backup party
+ * @param commonKeyChain 128-hex-char string: 32-byte pub + 32-byte rootChainCode
+ * @returns 64-byte Ed25519 signature Buffer
+ */
+export declare function signRecoveryEddsaMPCv2(message: Buffer, derivationPath: string, userKeyShare: Buffer, backupKeyShare: Buffer, commonKeyChain: string): Promise<Buffer>;
+export declare const EddsaMPCv2RecoveryFunctions: {
+    isEddsaMpcV1SigningMaterial: typeof isEddsaMpcV1SigningMaterial;
+    getEddsaMpcV2RecoveryKeySharesFromReducedKey: typeof getEddsaMpcV2RecoveryKeySharesFromReducedKey;
+    signRecoveryEddsaMPCv2: typeof signRecoveryEddsaMPCv2;
+};
+//# sourceMappingURL=eddsaMPCv2.d.ts.map

package/dist/src/bitgo/utils/tss/eddsa/eddsaMPCv2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eddsaMPCv2.d.ts","sourceRoot":"","sources":["../../../../../../src/bitgo/utils/tss/eddsa/eddsaMPCv2.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,6BAA6B,EAC7B,8BAA8B,EAC9B,6BAA6B,EAC7B,8BAA8B,EAI9B,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAsC,QAAQ,EAAW,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAsB,QAAQ,EAAW,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAarG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,+CAA+C,EAC/C,+CAA+C,EAC/C,+CAA+C,EAC/C,WAAW,EACX,oBAAoB,EAEpB,SAAS,EACT,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAChB,SAAS,EAEV,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAA6B,MAAM,0BAA0B,CAAC;AAC7F,OAAO,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEtD,qBAAa,eAAgB,SAAQ,cAAc;IACjD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAAkC;IACtF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAAkC;IACtF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAAkC;IACtF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,2BAA2B,CAAiC;IAEpF,kBAAkB;IACZ,eAAe,CAAC,MAAM,EAAE;QAC5B,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC;QACnB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,YAAY,CAAC,EAAE,yBAAyB,CAAC;QACzC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QAEtC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8JvB,iCAAiC,CAAC,MAAM,EAAE;QAC9C,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,yBAAyB,CAAC;KACtC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAuFvB,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,EACvC,YAAY,CAAC,EAAE,yBAAyB,EACxC,iBAAiB,CAAC,EAAE,iBAAiB,EACrC,UAAU,CAAC,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,CAAC;YAmEN,eAAe;YAyBf,iBAAiB;YAuBjB,gBAAgB;IAgBxB,uBAAuB,CAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,6BAA6B,EACtC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,8BAA8B,CAAC;IAIpC,+BAA+B,CACnC,QAAQ,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,EAChE,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,8BAA8B,CAAC;IAIpC,uBAAuB,CAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,8BAA8B,CAAC;IAIpC,+BAA+B,CACnC,QAAQ,EAAE,sBAAsB,CAAC,8BAA8B,CAAC,EAChE,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,8BAA8B,CAAC;IAQ1C;;;;;;OAMG;IACG,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAKjE;;;;;;OAMG;IACG,uBAAuB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,SAAS,CAAC;IAKrF;;;;;;;;;;OAUG;YACW,eAAe;IA0JvB,8BAA8B,CAAC,MAAM,EAAE;QAC3C,gBAAgB,EAAE,MAAM,CAAC;QACzB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,cAAc,EAAE,MAAM,CAAC;QACvB,qBAAqB,EAAE,MAAM,CAAC;QAC9B,OAAO,CAAC,EAAE,gBAAgB,CAAC,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC;KAC3D,GAAG,OAAO,CAAC;QACV,UAAU,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QACtC,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IA2CI,wBAAwB,CAAC,MAAM,EAAE;QACrC,SAAS,EAAE,SAAS,CAAC;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC;QACV,oBAAoB,EAAE,oBAAoB,CAAC;QAC3C,aAAa,EAAE,MAAM,CAAC;QACtB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IA0DI,wBAAwB,CAAC,MAAM,EAAE;QACrC,SAAS,EAAE,SAAS,CAAC;QACrB,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;IA0FI,wBAAwB,CAAC,MAAM,EAAE;QACrC,SAAS,EAAE,SAAS,CAAC;QACrB,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;IAgEF,kBAAkB;IACZ,oCAAoC,CACxC,MAAM,EAAE,SAAS,GAAG,mBAAmB,EACvC,8CAA8C,EAAE,+CAA+C,EAC/F,8CAA8C,EAAE,+CAA+C,EAC/F,8CAA8C,EAAE,+CAA+C,EAC/F,WAAW,GAAE,WAA4B,GACxC,OAAO,CAAC,SAAS,CAAC;CA0FtB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,2BAA2B,CAC/C,iBAAiB,EAAE,MAAM,EACzB,gBAAgB,EAAE,MAAM,EACxB,KAAK,CAAC,EAAE,SAAS,GAChB,OAAO,CAAC,OAAO,CAAC,CAgBlB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,4CAA4C,CAChE,gBAAgB,EAAE,MAAM,EACxB,kBAAkB,EAAE,MAAM,EAC1B,gBAAgB,CAAC,EAAE,MAAM,EACzB,KAAK,CAAC,EAAE,SAAS,GAChB,OAAO,CAAC,2BAA2B,CAAC,CAwCtC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC,CA0BjB;AAED,eAAO,MAAM,2BAA2B;;;;CAIvC,CAAC"}