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/tools/multi-delegation-data-gen/utils/utils.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-console, max-statements, max-params, @typescript-eslint/no-floating-promises */
-import { ValueTransferConfig, configLoader } from './config';
+import { Cardano } from '@cardano-sdk/core';
+import { logger } from '@cardano-sdk/util-dev';
+import { util } from '@cardano-sdk/key-management';
 
 import { BaseWallet } from '@cardano-sdk/wallet';
-import { Cardano } from '@cardano-sdk/core';
 import { Files, Paths } from './files';
 import {
   KeyAgentFactoryProps,
@@ -16,8 +17,7 @@ import {
 } from '../../../';
 import { Observable, filter, firstValueFrom, map } from 'rxjs';
 import { TaskResult, TerminalProgressMonitor } from './terminal-progress-monitor';
-import { logger } from '@cardano-sdk/util-dev';
-import { util } from '@cardano-sdk/key-management';
+import { ValueTransferConfig, configLoader } from './config';
 import chalk from 'chalk';
 
 /**
@@ -96,8 +96,15 @@ export const loadConfiguration = async (monitor: TerminalProgressMonitor) => {
 export const waitForFundingWallet = async (monitor: TerminalProgressMonitor): Promise<BaseWallet> => {
   monitor.startTask('Waiting for funding wallet to be ready.');
 
-  const fundingWallet = (await getWallet({ env, idx: 0, logger, name: 'Funding wallet', polling: { interval: 500 } }))
-    .wallet;
+  const fundingWallet = (
+    await getWallet({
+      env,
+      idx: 0,
+      logger,
+      name: 'Funding wallet',
+      polling: { interval: 500 }
+    })
+  ).wallet;
 
   await walletReady(fundingWallet);
 

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;
@@ -23,7 +23,8 @@ export const createMockKeyAgent = (deriveAddressesReturn: GroupedAddress[] = [])
       accountIndex,
       chainId,
       encryptedRootPrivateKeyBytes: [],
-      extendedAccountPublicKey
+      extendedAccountPublicKey,
+      purpose: KeyPurpose.STANDARD
     },
     signBlob: jest.fn(),
     signTransaction: jest.fn()

packages/e2e/src/util/handle-util.ts

@@ -2,7 +2,7 @@ import { Asset, Cardano, Handle, Serialization, metadatum, nativeScriptPolicyId,
 import { FinalizeTxProps, ObservableWallet } from '@cardano-sdk/wallet';
 import { HexBlob } from '@cardano-sdk/util';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
-import { KeyAgent, KeyRole, util as keyManagementUtil } from '@cardano-sdk/key-management';
+import { KeyAgent, KeyPurpose, KeyRole, util as keyManagementUtil } from '@cardano-sdk/key-management';
 import { firstValueFrom } from 'rxjs';
 import { readFile } from 'fs/promises';
 import { submitAndConfirm } from './util';
@@ -79,6 +79,7 @@ export const createHandleMetadata = (handlePolicyId: string, handleNames: string
 export const createHandlePolicy = async (keyAgent: KeyAgent) => {
   const derivationPath = {
     index: 0,
+    purpose: KeyPurpose.STANDARD,
     role: KeyRole.External
   };
   const pubKey = await keyAgent.derivePublicKey(derivationPath);

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/artillery/wallet-restoration/WalletRestoration.ts

@@ -1,4 +1,4 @@
-import { AddressType, GroupedAddress, util } from '@cardano-sdk/key-management';
+import { AddressType, GroupedAddress, KeyPurpose, util } from '@cardano-sdk/key-management';
 import { AddressesModel, WalletVars } from './types';
 import { Cardano } from '@cardano-sdk/core';
 import { FunctionHook } from '../artillery';
@@ -12,6 +12,7 @@ export const mapToGroupedAddress = (addrModel: AddressesModel): GroupedAddress =
   address: Cardano.PaymentAddress(addrModel.address),
   index: 0,
   networkId: addrModel.address.startsWith('addr_test') ? Cardano.NetworkId.Testnet : Cardano.NetworkId.Mainnet,
+  purpose: KeyPurpose.STANDARD,
   rewardAccount: Cardano.RewardAccount(addrModel.stake_address),
   type: AddressType.External
 });

packages/e2e/test/load-test-custom/wallet-init/wallet-init.test.ts

@@ -1,16 +1,8 @@
 /* eslint-disable import/imports-first */
 import * as dotenv from 'dotenv';
-import path from 'path';
-
-// This line must come before loading the env, to configure the location of the .env file
-dotenv.config({ path: path.join(__dirname, '../../../.env') });
-
 import { BaseWallet, createPersonalWallet } from '@cardano-sdk/wallet';
-import { Logger } from 'ts-log';
-import { bufferCount, bufferTime, from, mergeAll, tap } from 'rxjs';
-import { logger } from '@cardano-sdk/util-dev';
-
 import { Bip32Account, util } from '@cardano-sdk/key-management';
+import { Logger } from 'ts-log';
 import {
   MeasurementUtil,
   assetProviderFactory,
@@ -27,6 +19,12 @@ import {
   waitForWalletStateSettle,
   walletVariables
 } from '../../../src';
+import { bufferCount, bufferTime, from, mergeAll, tap } from 'rxjs';
+import { logger } from '@cardano-sdk/util-dev';
+import path from 'path';
+
+// This line must come before loading the env, to configure the location of the .env file
+dotenv.config({ path: path.join(__dirname, '../../../.env') });
 
 // Example call that creates 5000 wallets in 10 minutes:
 // VIRTUAL_USERS_GENERATE_DURATION=600 VIRTUAL_USERS_COUNT=5000 yarn load-test-custom:wallet-init

packages/e2e/test/local-network/register-pool.test.ts

@@ -12,11 +12,11 @@ import {
   walletReady,
   walletVariables
 } from '../../src';
+import { firstValueFrom } from 'rxjs';
 import { logger } from '@cardano-sdk/util-dev';
 
 import * as Crypto from '@cardano-sdk/crypto';
 import { AddressType, KeyRole } from '@cardano-sdk/key-management';
-import { firstValueFrom } from 'rxjs';
 
 const env = getEnv(walletVariables);
 

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 {
@@ -33,6 +34,7 @@ const DUMMY_HEX_BYTES =
 
 const DERIVATION_PATH: AccountKeyDerivationPath = {
   index: 0,
+  purpose: KeyPurpose.MULTI_SIG,
   role: KeyRole.External
 };
 
@@ -215,7 +217,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] }
     );
 
@@ -411,6 +413,7 @@ export class MultiSigWallet {
       address: baseAddress.toAddress().toBech32() as Cardano.PaymentAddress,
       index: 0,
       networkId,
+      purpose: KeyPurpose.MULTI_SIG,
       rewardAccount: Cardano.RewardAddress.fromCredentials(networkId, scriptCredential)
         .toAddress()
         .toBech32() as Cardano.RewardAccount,

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';
@@ -34,6 +34,7 @@ const charlotteMnemonics =
 
 const DERIVATION_PATH = {
   index: 0,
+  purpose: KeyPurpose.MULTI_SIG,
   role: KeyRole.External
 };
 
@@ -63,7 +64,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,11 +40,13 @@ 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 = {
       index: 2,
+      purpose: KeyPurpose.STANDARD,
       role: KeyRole.External
     };
 

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,21 +48,25 @@ 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 = {
       index: 2,
+      purpose: KeyPurpose.MULTI_SIG,
       role: KeyRole.External
     };
 
     const bobDerivationPath = {
       index: 3,
+      purpose: KeyPurpose.MULTI_SIG,
       role: KeyRole.External
     };