Feature: MultiSig support in executeTx of webmode (#785)

scale-it · Sep 15, 2022 · 72798a9 · 72798a9
1 parent 2895711
commit 72798a9
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -39,6 +39,7 @@ from `algosdk` and sends it to the network.
 
 #### @algo-builder/web
 - Added `appendSignMultisigTransaction` function to `WebMode` for appending signature to multisig transaction in the algosigner.
+- Added `MultiSignature` support in `executeTx` method for `AlgoSigner`.
 
 ### Bug Fixes
 

diff --git a/packages/web/src/lib/web-mode.ts b/packages/web/src/lib/web-mode.ts
@@ -9,6 +9,7 @@ import {
 	SignType,
 	TransactionAndSign,
 	TxParams,
+	SignWithMultisig
 } from "../types";
 import { WAIT_ROUNDS } from "./constants";
 import { log } from "./logger";
@@ -156,14 +157,14 @@ export class WebMode {
 	 * return an object containing a blob attribute encoded in base64
 	 */
 	async appendSignMultisigTransaction(txns: WalletTransaction[], signers: string[]): Promise<JsonPayload> {
-		const result:JsonPayload = {};
+		const result: JsonPayload = {};
 		for (let i = 0; i < txns.length; ++i) {
 			const txn = txns[i];
 			const partialTxn = algosdk.decodeObj(
-				this.algoSigner.encoding.base64ToMsgpack(txn.txn)) as EncodedSignedTransaction; 
+				this.algoSigner.encoding.base64ToMsgpack(txn.txn)) as EncodedSignedTransaction;
 			if (partialTxn.txn === undefined || partialTxn.msig === undefined) {
 				throw new Error("Input transaction must be multisigature transaction signed with at least 1 signature");
-			} 
+			}
 			const txnToBeSign = algosdk.Transaction.from_obj_for_encoding(partialTxn.txn);
 			const txnToBeSign_Uint8Array = algosdk.encodeObj(txnToBeSign.get_obj_for_encoding());
 			const txnToBeSign_Base64 = this.algoSigner.encoding.msgpackToBase64(txnToBeSign_Uint8Array);
@@ -242,19 +243,26 @@ export class WebMode {
 
 		// with logic signature we don't need signers.
 		const toBeSignedTxns = base64Txs.map((txn: string, txnId: number) => {
-			return execParams[txnId].sign === SignType.LogicSignature
-				? { txn: txn, signers: [] } // logic signature
-				: { txn: txn, authAddr: execParams[txnId].fromAccount?.addr }; // set signer
+			switch (execParams[txnId].sign) {
+				case SignType.LogicSignature:
+					return { txn: txn, signers: [] } // logic signature
+				case SignType.MultiSignature: {
+					const msig: SignWithMultisig = execParams[txnId] as SignWithMultisig;
+					return { txn: txn, msig: msig.mparams }; // multi singature
+				}
+				default:
+					return { txn: txn, authAddr: execParams[txnId].fromAccount?.addr }; // set signer
+			}
 		});
 
 		const signedTxn = await this.signTransaction(toBeSignedTxns);
 
 		// sign smart signature transaction
 		for (const [txnId, txn] of txns.entries()) {
-			const singer: Sign = execParams[txnId];
-			if (singer.sign === SignType.LogicSignature) {
-				singer.lsig.lsig.args = singer.args ? singer.args : [];
-				const lsigTxn = algosdk.signLogicSigTransaction(txn, singer.lsig);
+			const signer: Sign = execParams[txnId];
+			if (signer.sign === SignType.LogicSignature) {
+				signer.lsig.lsig.args = signer.args ? signer.args : [];
+				const lsigTxn = algosdk.signLogicSigTransaction(txn, signer.lsig);
 				signedTxn[txnId] = {
 					blob: this.algoSigner.encoding.msgpackToBase64(lsigTxn.blob),
 					txId: lsigTxn.txID,

diff --git a/packages/web/src/types.ts b/packages/web/src/types.ts
@@ -119,6 +119,7 @@ export type ExecParams =
 export enum SignType {
 	SecretKey,
 	LogicSignature,
+	MultiSignature
 }
 
 export enum TransactionType {
@@ -158,9 +159,16 @@ interface SignWithLsig {
 	args?: Uint8Array[];
 }
 
+export interface SignWithMultisig {
+	sign: SignType.MultiSignature;
+	mparams: WalletMultisigMetadata;
+	fromAccount?: AccountSDK;
+	fromAccountAddr: AccountAddress;
+}
+
 export type Lsig = SignWithLsig;
 
-export type Sign = SignWithSk | SignWithLsig;
+export type Sign = SignWithSk | SignWithLsig | SignWithMultisig;
 
 export type BasicParams = Sign & {
 	payFlags: TxParams;
@@ -235,11 +243,11 @@ export type UpdateAppParam = BasicParams &
 export type AppCallsParam = BasicParams &
 	AppOptionalFlags & {
 		type:
-			| TransactionType.CallApp
-			| TransactionType.ClearApp
-			| TransactionType.CloseApp
-			| TransactionType.DeleteApp
-			| TransactionType.OptInToApp;
+		| TransactionType.CallApp
+		| TransactionType.ClearApp
+		| TransactionType.CloseApp
+		| TransactionType.DeleteApp
+		| TransactionType.OptInToApp;
 		appID: number;
 	};