Skip to content

Commit 8f471b4

Browse files
greatertomigreatertomi
committed
feat: sign multi-sig transaction with trezor
1 parent c572657 commit 8f471b4

File tree

12 files changed

+248
-28
lines changed

12 files changed

+248
-28
lines changed

‎packages/core/src/Cardano/util/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ export * from './resolveInputValue';
55
export * from './phase2Validation';
66
export * from './addressesShareAnyKey';
77
export * from './plutusDataUtils';
8+
export * from './isScriptAddress';

‎packages/core/src/Cardano/util/isScriptAddress.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { Address, CredentialType, PaymentAddress } from '../Address';
2+
3+
export const isScriptAddress = (address: PaymentAddress): boolean => {
4+
const baseAddress = Address.fromBech32(address).asBase();
5+
const paymentCredential = baseAddress?.getPaymentCredential();
6+
const stakeCredential = baseAddress?.getStakeCredential();
7+
return paymentCredential?.type === CredentialType.ScriptHash && stakeCredential?.type === CredentialType.ScriptHash;
8+
};

‎packages/core/test/Cardano/util/isScriptAddress.test.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import { PaymentAddress } from '../../../src/Cardano';
2+
import { isScriptAddress } from '../../../src/Cardano/util';
3+
4+
describe('isScriptAddress', () => {
5+
it('returns false when it receives a non-script address', () => {
6+
const nonScriptAddress = PaymentAddress(
7+
'addr_test1qpfhhfy2qgls50r9u4yh0l7z67xpg0a5rrhkmvzcuqrd0znuzcjqw982pcftgx53fu5527z2cj2tkx2h8ux2vxsg475q9gw0lz'
8+
);
9+
expect(isScriptAddress(nonScriptAddress)).toBe(false);
10+
});
11+
12+
it('returns true when it receives a script address', () => {
13+
const scriptAddress = PaymentAddress(
14+
'addr_test1xr806j8xcq6cw6jjkzfxyewyue33zwnu4ajnu28hakp5fmc6gddlgeqee97vwdeafwrdgrtzp2rw8rlchjf25ld7r2ssptq3m9'
15+
);
16+
expect(isScriptAddress(scriptAddress)).toBe(true);
17+
});
18+
});

‎packages/hardware-ledger/src/transformers/txOut.ts

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,6 @@ import { LedgerTxTransformerContext } from '../types';
55
import { mapTokenMap } from './assets';
66
import { util } from '@cardano-sdk/key-management';
77

8-
const isScriptAddress = (address: string): boolean => {
9-
const baseAddress = Cardano.Address.fromBech32(address).asBase();
10-
const paymentCredential = baseAddress?.getPaymentCredential();
11-
const stakeCredential = baseAddress?.getStakeCredential();
12-
return (
13-
paymentCredential?.type === Cardano.CredentialType.ScriptHash &&
14-
stakeCredential?.type === Cardano.CredentialType.ScriptHash
15-
);
16-
};
17-
188
const toInlineDatum: Transform<Cardano.PlutusData, Ledger.Datum> = (datum) => ({
199
datumHex: Serialization.PlutusData.fromCore(datum).toCbor(),
2010
type: Ledger.DatumType.INLINE
@@ -30,9 +20,9 @@ const toDestination: Transform<Cardano.TxOut, Ledger.TxOutputDestination, Ledger
3020
context
3121
) => {
3222
const knownAddress = context?.knownAddresses.find((address) => address.address === txOut.address);
33-
const isScriptWallet = isScriptAddress(txOut.address);
23+
const isScriptAddress = Cardano.util.isScriptAddress(txOut.address);
3424

35-
if (knownAddress && !isScriptWallet) {
25+
if (knownAddress && !isScriptAddress) {
3626
const paymentKeyPath = util.paymentKeyPathFromGroupedAddress(knownAddress);
3727
const stakeKeyPath = util.stakeKeyPathFromGroupedAddress(knownAddress);
3828

‎packages/hardware-trezor/src/TrezorKeyAgent.ts

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/* eslint-disable @typescript-eslint/no-explicit-any */
22
import * as Crypto from '@cardano-sdk/crypto';
33
import * as Trezor from '@trezor/connect';
4+
import { BIP32Path } from '@cardano-sdk/crypto';
45
import { Cardano, NotImplementedError, Serialization } from '@cardano-sdk/core';
56
import {
67
CardanoKeyConst,
@@ -9,6 +10,7 @@ import {
910
KeyAgentDependencies,
1011
KeyAgentType,
1112
KeyPurpose,
13+
KeyRole,
1214
SerializableTrezorKeyAgentData,
1315
SignBlobResult,
1416
SignTransactionContext,
@@ -68,6 +70,10 @@ const containsOnlyScriptHashCredentials = (tx: Omit<Trezor.CardanoSignTransactio
6870
return !tx.withdrawals?.some((withdrawal) => !withdrawal.scriptHash);
6971
};
7072

73+
const multiSigWitnessPaths: BIP32Path[] = [
74+
util.accountKeyDerivationPathToBip32Path(0, { index: 0, role: KeyRole.External }, KeyPurpose.MULTI_SIG)
75+
];
76+
7177
const isMultiSig = (tx: Omit<Trezor.CardanoSignTransaction, 'signingMode'>): boolean => {
7278
const allThirdPartyInputs = !tx.inputs.some((input) => input.path);
7379
// Trezor doesn't allow change outputs to address controlled by your keys and instead you have to use script address for change out
@@ -100,7 +106,8 @@ export class TrezorKeyAgent extends KeyAgentBase {
100106
manifest,
101107
communicationType,
102108
silentMode = false,
103-
lazyLoad = false
109+
lazyLoad = false,
110+
shouldHandlePassphrase = false
104111
}: TrezorConfig): Promise<boolean> {
105112
const trezorConnect = getTrezorConnect(communicationType);
106113
try {
@@ -116,6 +123,23 @@ export class TrezorKeyAgent extends KeyAgentBase {
116123
// Show Trezor Suite popup. Disabled for node based apps
117124
popup: communicationType !== CommunicationType.Node && !silentMode
118125
});
126+
127+
if (shouldHandlePassphrase) {
128+
trezorConnect.on(Trezor.UI_EVENT, (event) => {
129+
// React on ui-request_passphrase event
130+
if (event.type === Trezor.UI.REQUEST_PASSPHRASE && event.payload.device) {
131+
trezorConnect.uiResponse({
132+
payload: {
133+
passphraseOnDevice: true,
134+
save: true,
135+
value: ''
136+
},
137+
type: Trezor.UI.RECEIVE_PASSPHRASE
138+
});
139+
}
140+
});
141+
}
142+
119143
return true;
120144
} catch (error: any) {
121145
if (error.code === 'Init_AlreadyInitialized') return true;
@@ -215,7 +239,7 @@ export class TrezorKeyAgent extends KeyAgentBase {
215239

216240
async signTransaction(
217241
txBody: Serialization.TransactionBody,
218-
{ knownAddresses, txInKeyPathMap }: SignTransactionContext
242+
{ knownAddresses, txInKeyPathMap, scripts }: SignTransactionContext
219243
): Promise<Cardano.Signatures> {
220244
try {
221245
await this.isTrezorInitialized;
@@ -235,12 +259,15 @@ export class TrezorKeyAgent extends KeyAgentBase {
235259
const trezorConnect = getTrezorConnect(this.#communicationType);
236260
const result = await trezorConnect.cardanoSignTransaction({
237261
...trezorTxData,
262+
...(signingMode === Trezor.PROTO.CardanoTxSigningMode.MULTISIG_TRANSACTION && {
263+
additionalWitnessRequests: multiSigWitnessPaths
264+
}),
238265
signingMode
239266
});
240267

241268
const expectedPublicKeys = await Promise.all(
242269
util
243-
.ownSignatureKeyPaths(body, knownAddresses, txInKeyPathMap)
270+
.ownSignatureKeyPaths(body, knownAddresses, txInKeyPathMap, undefined, scripts)
244271
.map((derivationPath) => this.derivePublicKey(derivationPath))
245272
);
246273

‎packages/hardware-trezor/src/transformers/txOut.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ const toDestination: Transform<Cardano.TxOut, TrezorTxOutputDestination, TrezorT
1010
context
1111
) => {
1212
const knownAddress = context?.knownAddresses.find((address: GroupedAddress) => address.address === txOut.address);
13+
const isScriptAddress = Cardano.util.isScriptAddress(txOut.address);
1314

14-
if (!knownAddress) {
15+
if (!knownAddress || isScriptAddress) {
1516
return {
1617
address: txOut.address
1718
};

‎packages/key-management/src/types.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ export interface TrezorConfig {
9292
email: string;
9393
appUrl: string;
9494
};
95+
// When set to true, Trezor automatically handle passphrase entry by forcing it to occur on the device
96+
shouldHandlePassphrase?: boolean;
9597
}
9698

9799
export interface SerializableKeyAgentDataBase {

‎packages/key-management/src/util/ownSignatureKeyPaths.ts

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as Crypto from '@cardano-sdk/crypto';
2-
import { AccountKeyDerivationPath, GroupedAddress, TxInId, TxInKeyPathMap } from '../types';
2+
import { AccountKeyDerivationPath, GroupedAddress, KeyRole, TxInId, TxInKeyPathMap } from '../types';
33
import { Cardano } from '@cardano-sdk/core';
44
import { DREP_KEY_DERIVATION_PATH } from './key';
55
import { Ed25519KeyHashHex } from '@cardano-sdk/crypto';
@@ -300,15 +300,24 @@ const checkStakeCredential = (address: GroupedAddress, keyHash: Crypto.Ed25519Ke
300300
? { derivationPaths: [address.stakeKeyDerivationPath], requiresForeignSignatures: false }
301301
: { derivationPaths: [], requiresForeignSignatures: true };
302302

303-
const checkPaymentCredential = (address: GroupedAddress, keyHash: Crypto.Ed25519KeyHashHex): SignatureCheck => {
303+
const checkPaymentCredential = (address: GroupedAddress, keyHash: Crypto.Ed25519KeyHashHex) => {
304304
const paymentCredential = Cardano.Address.fromBech32(address.address)?.asBase()?.getPaymentCredential();
305-
return paymentCredential?.type === Cardano.CredentialType.KeyHash &&
305+
if (
306+
paymentCredential?.type === Cardano.CredentialType.ScriptHash &&
306307
paymentCredential.hash === Crypto.Hash28ByteBase16.fromEd25519KeyHashHex(keyHash)
307-
? {
308-
derivationPaths: [{ index: address.index, role: Number(address.type) }],
309-
requiresForeignSignatures: false
310-
}
311-
: { derivationPaths: [], requiresForeignSignatures: true };
308+
)
309+
return {
310+
derivationPaths: [{ index: address.index, role: Number(address.type) }],
311+
requiresForeignSignatures: false
312+
};
313+
314+
if (paymentCredential?.type === Cardano.CredentialType.ScriptHash) {
315+
return {
316+
derivationPaths: [{ index: address.index, role: KeyRole.External }],
317+
requiresForeignSignatures: false
318+
};
319+
}
320+
return { derivationPaths: [], requiresForeignSignatures: true };
312321
};
313322

314323
const combineSignatureChecks = (a: SignatureCheck, b: SignatureCheck): SignatureCheck => ({

‎packages/key-management/test/util/ownSignaturePaths.test.ts

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const createGroupedAddress = (
3333
rewardAccount: Cardano.RewardAccount,
3434
type: AddressType,
3535
index: number,
36-
stakeKeyDerivationPath: AccountKeyDerivationPath
36+
stakeKeyDerivationPath?: AccountKeyDerivationPath
3737
) =>
3838
({
3939
...createBaseGroupedAddress(address, rewardAccount, type, index),
@@ -633,5 +633,45 @@ describe('KeyManagement.util.ownSignaturePaths', () => {
633633

634634
expect(util.ownSignatureKeyPaths(txBody, [knownAddress1], {}, undefined, scripts)).toEqual([]);
635635
});
636+
it('includes derivation paths for multi-signature native scripts', async () => {
637+
const scriptAddress = Cardano.PaymentAddress(
638+
'addr_test1xr806j8xcq6cw6jjkzfxyewyue33zwnu4ajnu28hakp5fmc6gddlgeqee97vwdeafwrdgrtzp2rw8rlchjf25ld7r2ssptq3m9'
639+
);
640+
const scriptRewardAccount = Cardano.RewardAccount(
641+
'stake_test17qdyxkl5vsvujlx8xu75hpk5p43q4phr3lutey420klp4gg7zmhrn'
642+
);
643+
const txBody: Cardano.TxBody = {
644+
fee: BigInt(0),
645+
inputs: [{}, {}, {}] as Cardano.TxIn[],
646+
outputs: []
647+
};
648+
649+
const scripts: Cardano.Script[] = [
650+
{
651+
__type: Cardano.ScriptType.Native,
652+
kind: Cardano.NativeScriptKind.RequireAnyOf,
653+
scripts: [
654+
{
655+
__type: Cardano.ScriptType.Native,
656+
keyHash: Ed25519KeyHashHex('b498c0eaceb9a8c7c829d36fc84e892113c9d2636b53b0636d7518b4'),
657+
kind: Cardano.NativeScriptKind.RequireSignature
658+
},
659+
{
660+
__type: Cardano.ScriptType.Native,
661+
keyHash: Ed25519KeyHashHex(otherStakeKeyHash),
662+
kind: Cardano.NativeScriptKind.RequireSignature
663+
}
664+
]
665+
}
666+
];
667+
668+
const knownAddress = createGroupedAddress(scriptAddress, scriptRewardAccount, AddressType.External, 0);
669+
expect(util.ownSignatureKeyPaths(txBody, [knownAddress], {}, undefined, scripts)).toEqual([
670+
{
671+
index: 0,
672+
role: KeyRole.External
673+
}
674+
]);
675+
});
636676
});
637677
});

‎packages/wallet/test/hardware/trezor/TrezorKeyAgent.test.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
Bip32Account,
55
CommunicationType,
66
SerializableTrezorKeyAgentData,
7+
TrezorConfig,
78
util
89
} from '@cardano-sdk/key-management';
910
import { AssetId, mockProviders as mocks } from '@cardano-sdk/util-dev';
@@ -31,12 +32,13 @@ describe('TrezorKeyAgent', () => {
3132
let txSubmitProvider: mocks.TxSubmitProviderStub;
3233
let address: Cardano.PaymentAddress;
3334

34-
const trezorConfig = {
35+
const trezorConfig: TrezorConfig = {
3536
communicationType: CommunicationType.Node,
3637
manifest: {
3738
appUrl: 'https://your.application.com',
3839
email: '[email protected]'
39-
}
40+
},
41+
shouldHandlePassphrase: true
4042
};
4143

4244
beforeAll(async () => {

0 commit comments

Comments
 (0)