feat: add cip-1854 support to keyagent

packages/cardano-services/test/StakePool/TypeormStakePoolProvider/util.test.ts

@@ -4,7 +4,7 @@ import { validateFuzzyOptions, withTextFilter } from '../../../src/StakePool/Typ
 describe('TypeormStakePoolProvider utils', () => {
   describe('validateFuzzyOptions', () => {
     it('throws if value is not a valid JSON encoded string', () =>
-      expect(() => validateFuzzyOptions('test')).toThrow('Unexpected token e in JSON at position 1'));
+      expect(() => validateFuzzyOptions('test')).toThrow(/Unexpected token/));
     it('throws if value is not an object', () =>
       expect(() => validateFuzzyOptions('"test"')).toThrow('must be an object'));
     it('throws without threshold', () =>

packages/e2e/src/factories.ts

@@ -204,7 +204,8 @@ keyManagementFactory.register('inMemory', async (params: any): Promise<CreateKey
           accountIndex: params.accountIndex,
           chainId: params.chainId,
           getPassphrase: async () => Buffer.from(params.passphrase),
-          mnemonicWords
+          mnemonicWords,
+          purpose: params.purpose
         },
         dependencies
       )
@@ -220,7 +221,8 @@ keyManagementFactory.register('ledger', async (params: any): Promise<CreateKeyAg
         accountIndex: params.accountIndex,
         chainId: params.chainId,
         communicationType: CommunicationType.Node,
-        deviceConnection
+        deviceConnection,
+        purpose: params.purpose
       },
       dependencies
     );
@@ -238,6 +240,7 @@ keyManagementFactory.register(
           {
             accountIndex: params.accountIndex,
             chainId: params.chainId,
+            purpose: params.purpose,
             trezorConfig: {
               communicationType: CommunicationType.Node,
               manifest: {

packages/e2e/src/scripts/mnemonic.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 import * as Crypto from '@cardano-sdk/crypto';
-import { AddressType, InMemoryKeyAgent, util } from '@cardano-sdk/key-management';
+import { AddressType, InMemoryKeyAgent, KeyPurpose, util } from '@cardano-sdk/key-management';
 import { localNetworkChainId } from '../util';
 
 /** Generates a new set of Mnemonic words and prints them to the console. */
@@ -14,7 +14,8 @@ import { localNetworkChainId } from '../util';
     {
       chainId: localNetworkChainId,
       getPassphrase: async () => Buffer.from(''),
-      mnemonicWords: mnemonicArray
+      mnemonicWords: mnemonicArray,
+      purpose: KeyPurpose.STANDARD
     },
     {
       bip32Ed25519: new Crypto.SodiumBip32Ed25519(),

packages/e2e/src/util/createMockKeyAgent.ts

@@ -1,6 +1,6 @@
 import { Bip32PublicKeyHex, SodiumBip32Ed25519 } from '@cardano-sdk/crypto';
 import { Cardano } from '@cardano-sdk/core';
-import { GroupedAddress, KeyAgent, KeyAgentType } from '@cardano-sdk/key-management';
+import { GroupedAddress, KeyAgent, KeyAgentType, KeyPurpose } from '@cardano-sdk/key-management';
 
 const accountIndex = 0;
 const chainId = Cardano.ChainIds.Preview;
@@ -18,12 +18,16 @@ export const createMockKeyAgent = (deriveAddressesReturn: GroupedAddress[] = [])
     derivePublicKey: jest.fn(),
     exportRootPrivateKey: jest.fn(),
     extendedAccountPublicKey,
+    get purpose(): KeyPurpose {
+      return KeyPurpose.STANDARD;
+    },
     serializableData: {
       __typename: KeyAgentType.InMemory,
       accountIndex,
       chainId,
       encryptedRootPrivateKeyBytes: [],
-      extendedAccountPublicKey
+      extendedAccountPublicKey,
+      purpose: KeyPurpose.STANDARD
     },
     signBlob: jest.fn(),
     signTransaction: jest.fn()

packages/e2e/src/util/util.ts

@@ -18,7 +18,7 @@ import {
   timeout
 } from 'rxjs';
 import { FAST_OPERATION_TIMEOUT_DEFAULT, SYNC_TIMEOUT_DEFAULT } from '../defaults';
-import { InMemoryKeyAgent, TransactionSigner } from '@cardano-sdk/key-management';
+import { InMemoryKeyAgent, KeyPurpose, TransactionSigner } from '@cardano-sdk/key-management';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { TestWallet, networkInfoProviderFactory } from '../factories';
 import { getEnv, walletVariables } from '../environment';
@@ -228,17 +228,20 @@ export const submitCertificate = async (certificate: Cardano.Certificate, wallet
  * @param mnemonics The random set of mnemonics.
  * @param genesis Network genesis parameters
  * @param bip32Ed25519 The Ed25519 cryptography implementation.
+ * @param purpose they key derivation purpose of either 1852 or 1854
  */
 export const createStandaloneKeyAgent = async (
   mnemonics: string[],
   genesis: Cardano.CompactGenesis,
-  bip32Ed25519: Crypto.Bip32Ed25519
+  bip32Ed25519: Crypto.Bip32Ed25519,
+  purpose: KeyPurpose
 ) =>
   await InMemoryKeyAgent.fromBip39MnemonicWords(
     {
       chainId: genesis,
       getPassphrase: async () => Buffer.from(''),
-      mnemonicWords: mnemonics
+      mnemonicWords: mnemonics,
+      purpose
     },
     { bip32Ed25519, logger }
   );

packages/e2e/test/long-running/multisig-wallet/MultiSigWallet.ts

@@ -4,6 +4,7 @@ import {
   AddressType,
   GroupedAddress,
   InMemoryKeyAgent,
+  KeyPurpose,
   KeyRole
 } from '@cardano-sdk/key-management';
 import {
@@ -215,7 +216,7 @@ export class MultiSigWallet {
         body: multiSigTx.getTransaction().body,
         hash: multiSigTx.getTransaction().id
       },
-      { knownAddresses: [this.#address], txInKeyPathMap: {} },
+      { knownAddresses: [this.#address], purpose: KeyPurpose.MULTI_SIG, txInKeyPathMap: {} },
       { additionalKeyPaths: [DERIVATION_PATH] }
     );
 

packages/e2e/test/long-running/multisig-wallet/multisig-delegation-rewards.test.ts

@@ -1,7 +1,7 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { BaseWallet } from '@cardano-sdk/wallet';
 import { Cardano, EraSummary, StakePoolProvider, createSlotEpochCalc } from '@cardano-sdk/core';
-import { InMemoryKeyAgent, KeyRole } from '@cardano-sdk/key-management';
+import { InMemoryKeyAgent, KeyPurpose, KeyRole } from '@cardano-sdk/key-management';
 import { MultiSigTx } from './MultiSigTx';
 import { MultiSigWallet } from './MultiSigWallet';
 import { Observable, filter, firstValueFrom, map, take } from 'rxjs';
@@ -63,7 +63,7 @@ const fundMultiSigWallet = async (sendingWallet: BaseWallet, address: Cardano.Pa
 const getKeyAgent = async (mnemonics: string, faucetWallet: BaseWallet, bip32Ed25519: Crypto.Bip32Ed25519) => {
   const genesis = await firstValueFrom(faucetWallet.genesisParameters$);
 
-  const keyAgent = await createStandaloneKeyAgent(mnemonics.split(' '), genesis, bip32Ed25519);
+  const keyAgent = await createStandaloneKeyAgent(mnemonics.split(' '), genesis, bip32Ed25519, KeyPurpose.STANDARD);
 
   const pubKey = await keyAgent.derivePublicKey(DERIVATION_PATH);
 

packages/e2e/test/wallet_epoch_0/PersonalWallet/handle.test.ts

@@ -1,7 +1,7 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 import { BaseWallet } from '@cardano-sdk/wallet';
 import { Cardano, metadatum } from '@cardano-sdk/core';
-import { KeyAgent, TransactionSigner } from '@cardano-sdk/key-management';
+import { KeyAgent, KeyPurpose, TransactionSigner } from '@cardano-sdk/key-management';
 import {
   bip32Ed25519Factory,
   burnTokens,
@@ -50,7 +50,8 @@ describe('Ada handle', () => {
     keyAgent = await createStandaloneKeyAgent(
       env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
       await firstValueFrom(wallet.genesisParameters$),
-      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger)
+      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger),
+      KeyPurpose.STANDARD
     );
     ({ policyScript, policySigner, policyId } = await createHandlePolicy(keyAgent));
     const handleProviderPolicyId = await getHandlePolicyId(

packages/e2e/test/wallet_epoch_0/PersonalWallet/mint.test.ts

@@ -1,7 +1,7 @@
 import { BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
 import { Cardano, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
-import { KeyRole, util } from '@cardano-sdk/key-management';
+import { KeyPurpose, KeyRole, util } from '@cardano-sdk/key-management';
 import {
   bip32Ed25519Factory,
   burnTokens,
@@ -40,7 +40,8 @@ describe('PersonalWallet/mint', () => {
     const aliceKeyAgent = await createStandaloneKeyAgent(
       env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
       genesis,
-      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger)
+      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger),
+      KeyPurpose.STANDARD
     );
 
     const derivationPath = {

packages/e2e/test/wallet_epoch_0/PersonalWallet/multiAddress.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/no-duplicate-string */
-import { AddressType, GroupedAddress, util } from '@cardano-sdk/key-management';
+import { AddressType, GroupedAddress, KeyPurpose, util } from '@cardano-sdk/key-management';
 import { BaseWallet } from '@cardano-sdk/wallet';
 import { Cardano } from '@cardano-sdk/core';
 import {
@@ -43,7 +43,8 @@ describe('PersonalWallet/multiAddress', () => {
     const multiAddressKeyAgent = await createStandaloneKeyAgent(
       mnemonics,
       genesis,
-      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger)
+      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger),
+      KeyPurpose.STANDARD
     );
 
     let txBuilder = wallet.createTxBuilder();

packages/e2e/test/wallet_epoch_0/PersonalWallet/multisignature.test.ts

@@ -2,7 +2,7 @@
 import { BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
 import { Cardano, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
-import { KeyRole, util } from '@cardano-sdk/key-management';
+import { KeyPurpose, KeyRole, util } from '@cardano-sdk/key-management';
 import {
   bip32Ed25519Factory,
   burnTokens,
@@ -48,12 +48,14 @@ describe('PersonalWallet/multisignature', () => {
     const aliceKeyAgent = await createStandaloneKeyAgent(
       env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
       genesis,
-      bip32Ed25519
+      bip32Ed25519,
+      KeyPurpose.MULTI_SIG
     );
     const bobKeyAgent = await createStandaloneKeyAgent(
       env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
       genesis,
-      bip32Ed25519
+      bip32Ed25519,
+      KeyPurpose.MULTI_SIG
     );
 
     const aliceDerivationPath = {

packages/e2e/test/wallet_epoch_0/PersonalWallet/nft.test.ts

@@ -2,7 +2,7 @@
 import { Asset, Cardano, metadatum, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { Assets, BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
-import { KeyRole, TransactionSigner, util } from '@cardano-sdk/key-management';
+import { KeyPurpose, KeyRole, TransactionSigner, util } from '@cardano-sdk/key-management';
 import {
   bip32Ed25519Factory,
   burnTokens,
@@ -61,7 +61,8 @@ describe('PersonalWallet.assets/nft', () => {
     const keyAgent = await createStandaloneKeyAgent(
       env.KEY_MANAGEMENT_PARAMS.mnemonic.split(' '),
       genesis,
-      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger)
+      await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger),
+      KeyPurpose.STANDARD
     );
 
     const derivationPath = {

packages/e2e/test/wallet_epoch_0/SharedWallet/utils.ts

@@ -2,6 +2,7 @@ import * as Crypto from '@cardano-sdk/crypto';
 import {
   AccountKeyDerivationPath,
   KeyAgent,
+  KeyPurpose,
   KeyRole,
   SignBlobResult,
   SignDataContext,
@@ -30,7 +31,12 @@ const getKeyAgent = async (
   genesisParameters: Cardano.CompactGenesis,
   bip32Ed25519: Crypto.Bip32Ed25519
 ) => {
-  const keyAgent = await createStandaloneKeyAgent(mnemonics.split(' '), genesisParameters, bip32Ed25519);
+  const keyAgent = await createStandaloneKeyAgent(
+    mnemonics.split(' '),
+    genesisParameters,
+    bip32Ed25519,
+    KeyPurpose.STANDARD
+  );
 
   const pubKey = await keyAgent.derivePublicKey(DERIVATION_PATH);
 

packages/e2e/test/web-extension/extension/ui.ts

@@ -31,6 +31,7 @@ import { Cardano } from '@cardano-sdk/core';
 import {
   CommunicationType,
   InMemoryKeyAgent,
+  KeyPurpose,
   SerializableInMemoryKeyAgentData,
   emip3encrypt
 } from '@cardano-sdk/key-management';
@@ -304,7 +305,8 @@ const createWalletIfNotExistsAndActivate = async (accountIndex: number) => {
         accountIndex,
         chainId: env.KEY_MANAGEMENT_PARAMS.chainId,
         getPassphrase: async () => passphrase,
-        mnemonicWords
+        mnemonicWords,
+        purpose: KeyPurpose.STANDARD
       },
       { bip32Ed25519, logger }
     );

packages/hardware-ledger/src/LedgerKeyAgent.ts

@@ -8,6 +8,7 @@ import {
   KeyAgentBase,
   KeyAgentDependencies,
   KeyAgentType,
+  KeyPurpose,
   SerializableLedgerKeyAgentData,
   SignBlobResult,
   SignTransactionContext,
@@ -67,12 +68,14 @@ export interface CreateLedgerKeyAgentProps {
   accountIndex?: number;
   communicationType: CommunicationType;
   deviceConnection?: LedgerConnection | null;
+  purpose: KeyPurpose;
 }
 
 export interface GetLedgerXpubProps {
   deviceConnection?: LedgerConnection;
   communicationType: CommunicationType;
   accountIndex: number;
+  purpose: KeyPurpose;
 }
 
 export interface CreateLedgerTransportProps {
@@ -434,11 +437,12 @@ export class LedgerKeyAgent extends KeyAgentBase {
   static async getXpub({
     deviceConnection,
     communicationType,
-    accountIndex
+    accountIndex,
+    purpose
   }: GetLedgerXpubProps): Promise<Crypto.Bip32PublicKeyHex> {
     try {
       const recoveredDeviceConnection = await LedgerKeyAgent.checkDeviceConnection(communicationType, deviceConnection);
-      const derivationPath = `${CardanoKeyConst.PURPOSE}'/${CardanoKeyConst.COIN_TYPE}'/${accountIndex}'`;
+      const derivationPath = `${purpose}'/${CardanoKeyConst.COIN_TYPE}'/${accountIndex}'`;
       const extendedPublicKey = await recoveredDeviceConnection.getExtendedPublicKey({
         path: str_to_path(derivationPath) // BIP32Path
       });
@@ -468,7 +472,7 @@ export class LedgerKeyAgent extends KeyAgentBase {
    * @throws TransportError
    */
   static async createWithDevice(
-    { chainId, accountIndex = 0, communicationType, deviceConnection }: CreateLedgerKeyAgentProps,
+    { chainId, accountIndex = 0, communicationType, deviceConnection, purpose }: CreateLedgerKeyAgentProps,
     dependencies: KeyAgentDependencies
   ) {
     const deviceListPaths = await LedgerKeyAgent.getHidDeviceList(communicationType);
@@ -479,7 +483,8 @@ export class LedgerKeyAgent extends KeyAgentBase {
     const extendedAccountPublicKey = await LedgerKeyAgent.getXpub({
       accountIndex,
       communicationType,
-      deviceConnection: activeDeviceConnection
+      deviceConnection: activeDeviceConnection,
+      purpose
     });
 
     return new LedgerKeyAgent(
@@ -488,7 +493,8 @@ export class LedgerKeyAgent extends KeyAgentBase {
         chainId,
         communicationType,
         deviceConnection: activeDeviceConnection,
-        extendedAccountPublicKey
+        extendedAccountPublicKey,
+        purpose
       },
       dependencies
     );
@@ -539,14 +545,15 @@ export class LedgerKeyAgent extends KeyAgentBase {
   // TODO: Allow additional key paths
   async signTransaction(
     { body, hash }: Cardano.TxBodyWithHash,
-    { knownAddresses, txInKeyPathMap }: SignTransactionContext
+    { knownAddresses, txInKeyPathMap, purpose }: SignTransactionContext
   ): Promise<Cardano.Signatures> {
     try {
       const ledgerTxData = await toLedgerTx(body, {
         accountIndex: this.accountIndex,
         chainId: this.chainId,
         dRepPublicKey: await this.derivePublicKey(util.DREP_KEY_DERIVATION_PATH),
         knownAddresses,
+        purpose,
         txInKeyPathMap
       });
 

packages/hardware-ledger/src/transformers/txIn.ts

@@ -6,14 +6,18 @@ import { TxInId, util } from '@cardano-sdk/key-management';
 
 const resolveKeyPath = (
   txIn: Cardano.TxIn,
-  { accountIndex, txInKeyPathMap }: LedgerTxTransformerContext
+  { accountIndex, txInKeyPathMap, purpose }: LedgerTxTransformerContext
 ): Ledger.BIP32Path | null => {
-  const utxoKeyPath = txInKeyPathMap[TxInId(txIn)];
-  if (utxoKeyPath) {
-    return util.accountKeyDerivationPathToBip32Path(accountIndex, utxoKeyPath);
-  }
+  const txInKeyPath = txInKeyPathMap[TxInId(txIn)];
 
-  return null;
+  if (!txInKeyPath || txInKeyPath.role === undefined || txInKeyPath.index === undefined) return null;
+
+  const utxoKeyPath = {
+    ...txInKeyPath,
+    purpose
+  };
+
+  return util.accountKeyDerivationPathToBip32Path(accountIndex, utxoKeyPath);
 };
 
 export const toTxIn: Transform<Cardano.TxIn, Ledger.TxInput, LedgerTxTransformerContext> = (txIn, context) => ({