Multisig: Connect request and SignMultisigTransaction request

.eslintignore

@@ -1,3 +1,4 @@
 *.min.*
 src/lib/bitcoin/BitcoinJS.js
 src/lib/polygon/OpenGSN.js
+src/lib/multisig/wasm/pkg

client/src/KeyguardClient.ts

@@ -20,6 +20,7 @@ import {
     ReleaseKeyRequest,
     ResetPasswordRequest,
     SignTransactionRequest,
+    SignMultisigTransactionRequest,
     SignStakingRequest,
     SignMessageRequest,
     SimpleRequest,
@@ -40,6 +41,7 @@ import {
     SignSwapRequest,
     SignSwapTransactionsRequest,
     SignSwapTransactionsResult,
+    ConnectRequest,
 } from './PublicRequest';
 
 import Observable from './Observable';
@@ -121,6 +123,10 @@ export class KeyguardClient {
         this._redirectRequest<SignTransactionRequest>(KeyguardCommand.SIGN_TRANSACTION, request);
     }
 
+    public signMultisigTransaction(request: SignMultisigTransactionRequest) {
+        this._redirectRequest<SignMultisigTransactionRequest>(KeyguardCommand.SIGN_MULTISIG_TRANSACTION, request);
+    }
+
     public signStaking(request: SignStakingRequest) {
         this._redirectRequest<SignStakingRequest>(KeyguardCommand.SIGN_STAKING, request);
     }
@@ -153,6 +159,10 @@ export class KeyguardClient {
         this._redirectRequest<SignSwapRequest>(KeyguardCommand.SIGN_SWAP, request);
     }
 
+    public connectAccount(request: ConnectRequest) {
+        this._redirectRequest<ConnectRequest>(KeyguardCommand.CONNECT_ACCOUNT, request);
+    }
+
     /* IFRAME REQUESTS */
 
     public async list(): Promise<ListResult> {

client/src/KeyguardCommand.ts

@@ -5,8 +5,10 @@ export enum KeyguardCommand {
     EXPORT = 'export',
     CHANGE_PASSWORD = 'change-password',
     SIGN_TRANSACTION = 'sign-transaction',
+    SIGN_MULTISIG_TRANSACTION = 'sign-multisig-transaction',
     SIGN_STAKING = 'sign-staking',
     SIGN_MESSAGE = 'sign-message',
+    CONNECT_ACCOUNT = 'connect',
     DERIVE_ADDRESS = 'derive-address',
 
     // Bitcoin

client/src/PublicRequest.ts

@@ -94,6 +94,7 @@ export type BitcoinTransactionInfo = {
 };
 
 export type SignTransactionRequestLayout = 'standard' | 'checkout' | 'cashlink';
+export type SignMultisigTransactionRequestLayout = 'standard';
 export type SignBtcTransactionRequestLayout = 'standard' | 'checkout';
 
 // Specific Requests
@@ -189,6 +190,40 @@ export type SignTransactionRequest
     | SignTransactionRequestCheckout
     | SignTransactionRequestCashlink;
 
+export type EncryptionKeyParams = {
+    kdf: string,
+    iterations: number,
+    keySize: number,
+};
+
+export type MultisigConfig = {
+    publicKeys: Uint8Array[],
+    signers: Array<{
+        publicKey: Uint8Array,
+        commitments: Uint8Array[],
+    }>,
+    secrets: Uint8Array[] | {
+        encrypted: Uint8Array[],
+        keyParams: EncryptionKeyParams,
+    },
+    userName?: string,
+};
+
+export type SignMultisigTransactionRequestCommon = Transform<SignTransactionRequestCommon, 'keyLabel' | 'senderLabel', {
+    keyLabel: string, // Not optional
+    senderLabel: string, // Not optional
+}> & {
+    multisigConfig: MultisigConfig,
+};
+
+export type SignMultisigTransactionRequestStandard = SignMultisigTransactionRequestCommon & {
+    layout?: 'standard',
+    recipientLabel?: string,
+};
+
+export type SignMultisigTransactionRequest
+    = SignMultisigTransactionRequestStandard;
+
 export type SignStakingRequest = SimpleRequest & {
     keyPath: string,
     transaction: Uint8Array | Uint8Array[], // An array is only allowed for retire_stake + remove_stake transactions
@@ -492,6 +527,24 @@ export type DerivePolygonAddressResult = {
     }>,
 };
 
+export type ConnectRequest = SimpleRequest & {
+    appLogoUrl: string,
+    permissions: KeyguardCommand[],
+    requestedKeyPaths: string[],
+    challenge: string,
+};
+
+export type ConnectResult = {
+    signatures: SignatureResult[],
+    encryptionKey: {
+        format: 'spki',
+        keyData: Uint8Array,
+        algorithm: { name: string, hash: string },
+        keyUsages: ['encrypt'],
+        keyParams: EncryptionKeyParams,
+    },
+};
+
 // Request unions
 
 export type RedirectRequest
@@ -501,10 +554,12 @@ export type RedirectRequest
     | ImportRequest
     | RemoveKeyRequest
     | SignMessageRequest
+    | ConnectRequest
     | SignTransactionRequest
     | SignStakingRequest
     | SignBtcTransactionRequest
     | SignPolygonTransactionRequest
+    | SignMultisigTransactionRequest
     | SimpleRequest
     | DeriveBtcXPubRequest
     | DerivePolygonAddressRequest
@@ -545,6 +600,7 @@ export type ListLegacyResult = LegacyKeyInfoObject[];
 export type SignTransactionResult = SignatureResult & {
     serializedTx: Uint8Array,
 };
+export type SignMultisigTransactionResult = SignatureResult;
 export type SignStakingResult = SignatureResult & {
     transaction: Uint8Array,
 };
@@ -579,7 +635,10 @@ export type RedirectResult
     = DerivedAddress[]
     | ExportResult
     | KeyResult
+    | SignatureResult
+    | ConnectResult
     | SignTransactionResult
+    | SignMultisigTransactionResult
     | SignStakingResult[]
     | SignedBitcoinTransaction
     | SignedPolygonTransaction
@@ -593,8 +652,11 @@ export type Result = RedirectResult | IFrameResult;
 // Derived Result types
 
 export type ResultType<T extends RedirectRequest> =
-    T extends Is<T, SignMessageRequest> | Is<T, SignTransactionRequest> ? SignatureResult :
+    T extends Is<T, SignMessageRequest> ? SignatureResult :
+    T extends Is<T, SignTransactionRequest> ? SignTransactionResult :
+    T extends Is<T, SignMultisigTransactionRequest> ? SignMultisigTransactionResult :
     T extends Is<T, SignStakingRequest> ? SignStakingResult[] :
+    T extends Is<T, ConnectRequest> ? ConnectResult :
     T extends Is<T, DeriveAddressRequest> ? DerivedAddress[] :
     T extends Is<T, CreateRequest> | Is<T, ImportRequest> | Is<T, ResetPasswordRequest> ? KeyResult :
     T extends Is<T, ExportRequest> ? ExportResult :
@@ -607,8 +669,11 @@ export type ResultType<T extends RedirectRequest> =
     never;
 
 export type ResultByCommand<T extends KeyguardCommand> =
-    T extends KeyguardCommand.SIGN_MESSAGE | KeyguardCommand.SIGN_TRANSACTION ? SignatureResult :
+    T extends KeyguardCommand.SIGN_MESSAGE ? SignatureResult :
+    T extends KeyguardCommand.SIGN_TRANSACTION ? SignTransactionResult :
+    T extends KeyguardCommand.SIGN_MULTISIG_TRANSACTION ? SignMultisigTransactionResult :
     T extends KeyguardCommand.SIGN_STAKING ? SignStakingResult[] :
+    T extends KeyguardCommand.CONNECT_ACCOUNT ? ConnectResult :
     T extends KeyguardCommand.DERIVE_ADDRESS ? DerivedAddress[] :
     T extends KeyguardCommand.CREATE | KeyguardCommand.IMPORT ? KeyResult :
     T extends KeyguardCommand.EXPORT ? ExportResult :

demos/ConnectAccount.html

@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>SignTransaction | Keyguard Demo</title>
+    <link href="../src/nimiq-style.css" rel="stylesheet">
+    <script src="../node_modules/@nimiq/core-web/web-offline.js"></script>
+    <script src="../src/lib/KeyInfo.js"></script>
+    <script src="../src/lib/KeyStore.js"></script>
+    <script src="../node_modules/@nimiq/rpc/dist/rpc.umd.js"></script>
+
+    <style>
+        .row {
+            margin: 1rem 0;
+        }
+
+        label, input {
+            display: block;
+            margin: 5px;
+        }
+
+        #result {
+            max-width: 900px;
+            overflow-wrap: break-word;
+        }
+    </style>
+</head>
+<body>
+
+<form class="center">
+    <div class="row">
+        <label>Account to connect</label>
+        <select id="account"></select>
+    </div>
+
+    <div class="row">
+        <label>Challenge</label>
+		<input id="challenge" value="some random characters">
+    </div>
+
+    <div class="row">
+        <label>Permissions</label>
+		<label>
+			<input type="checkbox" id="permission-sign-multisig-transaction" checked> sign-multisig-transaction
+		</label>
+    </div>
+
+    <!-- <br><button id="redirect" type="button" class="small" disabled>Connect Account (redirect)</button> -->
+    <br><button id="popup" type="button" class="small">Connect Account (popup)</button>
+
+    <p id="result"></p>
+</form>
+
+<script>
+    const accountSelector = document.querySelector('#account');
+
+	async function loadAccounts() {
+		/** @type {KeyInfo[]} */
+		const keyInfos = await KeyStore.instance.list();
+		const dom = document.createDocumentFragment();
+		for (const keyInfo of keyInfos) {
+			const option = document.createElement('option');
+			option.value = keyInfo.id;
+			option.textContent = keyInfo.defaultAddress.toUserFriendlyAddress();
+			dom.appendChild(option);
+		}
+		accountSelector.appendChild(dom);
+	}
+	loadAccounts();
+
+    document.querySelector('button#popup').addEventListener('click', async () => {
+        connectAccountPopup(await generateRequest());
+    });
+
+    async function generateRequest() {
+        const keyId = accountSelector.value;
+        const challenge = document.querySelector('#challenge').value;
+		const permissions = ['sign-multisig-transaction']; // TODO
+
+        const request = {
+            appName: 'Nimiq Multisig',
+
+            keyId,
+            keyLabel: 'Some Account',
+
+            appLogoUrl: `${window.location.origin}/demos/multisig-logo.svg`,
+			permissions,
+            requestedKeyPaths: [`m/44'/242'/0'/0'`],
+			challenge,
+        };
+
+        return request;
+    }
+
+    // function connectAccountRedirect(txRequest) {
+    //     return client.connect(txRequest, RedirectRequestBehavior.withLocalState({ keyId: txRequest.keyId }));
+    // }
+
+    async function connectAccountPopup(txRequest) {
+        const keyguard = window.open('../src/request/connect/', 'ConnectAccount Demo',
+            `left=${window.innerWidth / 2 - 350},top=75,width=700,height=850,location=yes,dependent=yes`);
+        const rpc = new Rpc.PostMessageRpcClient(keyguard, '*');
+        await rpc.init();
+
+        try {
+            const result = await rpc.call('request', txRequest);
+            console.log('Keyguard result:', result);
+            document.querySelector('#result').textContent = 'TX signed: ' + JSON.stringify(result);
+        } catch (e) {
+            console.error('Keyguard error', e);
+            document.querySelector('#result').textContent = `Error: ${e.message || e}`;
+        }
+
+        keyguard.close();
+    }
+</script>
+
+</body>
+</html>