@cardano-sdk/e2e 0.25.0 → 0.26.0

package/test/artillery/artillery.ts

@@ -1,18 +1,12 @@
 import { Agent, IncomingMessage } from 'http';
 import { Agent as HttpsAgent } from 'https';
 
-/**
- * Artillery context
- */
+/** Artillery context */
 export interface ArtilleryContext<T> {
-  /**
-   * The unique Id of the virtual user
-   */
+  /** The unique Id of the virtual user */
   _uid: string;
 
-  /**
-   * The variables of the virtual user session
-   */
+  /** The variables of the virtual user session */
   vars: T;
 }
 
@@ -32,89 +26,54 @@ interface ArtilleryEventEmitter extends EventEmitter {
   removeListener<Event extends keyof ArtilleryEvents>(event: Event, listener: ArtilleryEvents[Event]): this;
 }
 
-/**
- * Parameters of an Artillery request
- */
+/** Parameters of an Artillery request */
 export interface Params {
-  /**
-   * Name of the afterResponse hook
-   */
+  /** Name of the afterResponse hook */
   afterResponse?: string;
 
-  /**
-   * The agent used to for the request
-   */
+  /** The agent used to for the request */
   agent?: { http: Agent; https: HttpsAgent };
 
-  /**
-   * Name of the beforeRequest hook
-   */
+  /** Name of the beforeRequest hook */
   beforeRequest?: string;
 
-  /**
-   * The variables to capture from the response
-   */
+  /** The variables to capture from the response */
   capture: { as: string; json: string }[];
 
-  /**
-   * Unknown
-   */
+  /** Unknown */
   decompress?: boolean;
 
-  /**
-   * Not yet tested in IOG
-   */
+  /** Not yet tested in IOG */
   followRedirect?: boolean;
 
-  /**
-   * Not yet tested in IOG
-   */
+  /** Not yet tested in IOG */
   followAllRedirects?: boolean;
 
-  /**
-   * The HTTP headers of the request
-   */
+  /** The HTTP headers of the request */
   headers?: Record<string, string>;
 
-  /**
-   * Unknown
-   */
+  /** Unknown */
   https?: unknown;
 
-  /**
-   * The json body for POST. Its value is the raw configured one in beforeRequest
-   * and the evaluated one in afterResponse
-   */
+  /** The json body for POST. Its value is the raw configured one in beforeRequest and the evaluated one in afterResponse */
   json?: unknown;
 
-  /**
-   * Unknown
-   */
+  /** Unknown */
   match?: unknown[];
 
-  /**
-   * The HTTP method of the request
-   */
+  /** The HTTP method of the request */
   method: 'DELETE' | 'GET' | 'POST' | 'PUT';
 
-  /**
-   * Unknown
-   */
+  /** Unknown */
   retry: number;
 
-  /**
-   * Unknown
-   */
+  /** Unknown */
   throwHttpErrors?: boolean;
 
-  /**
-   * The time out of the request in ms
-   */
+  /** The time out of the request in ms */
   timeout: number;
 
-  /**
-   * URL of the request
-   */
+  /** URL of the request */
   url: string;
 }
 

package/test/artillery/wallet-restoration/WalletRestoration.ts

@@ -79,9 +79,7 @@ export const getAddresses: FunctionHook<WalletVars> = async ({ vars }, _, done)
   done();
 };
 
-/**
- * The current index of found addresses list
- */
+/** The current index of found addresses list */
 let index = 0;
 
 export const walletRestoration: FunctionHook<WalletVars> = async ({ vars, _uid }, ee, done) => {

package/test/artillery/wallet-restoration/queries.ts

@@ -1,6 +1,4 @@
-/**
- * Query distinct addresses from db associated with users who are staking.
- */
+/** Query distinct addresses from db associated with users who are staking. */
 export const findAddressesWithRegisteredStakeKey = `
     SELECT COUNT(*) AS tx_count, address, sa.view as stake_address
     FROM tx_out 

package/test/artillery/wallet-restoration/types.ts

@@ -1,9 +1,7 @@
 import { GroupedAddress } from '@cardano-sdk/key-management';
 import { PersonalWallet } from '@cardano-sdk/wallet';
 
-/**
- * The context variables shared between all the hooks.
- */
+/** The context variables shared between all the hooks. */
 export interface WalletVars {
   walletLoads: number;
   addresses: GroupedAddress[];

package/test/load-test-custom/stake-pool-search/stake-pool-search.test.ts

@@ -39,9 +39,7 @@ enum MeasureTarget {
 
 const PAGE_SIZE = 20;
 
-/**
- * The set of pools id found while getting results
- */
+/** The set of pools id found while getting results */
 const poolIds: Cardano.PoolId[] = [];
 
 const measurement = new MeasurementUtil<MeasureTarget | string>();

package/test/load-test-custom/wallet-init/wallet-init.test.ts

@@ -26,6 +26,7 @@ import {
   waitForWalletStateSettle,
   walletVariables
 } from '../../../src';
+import { util } from '@cardano-sdk/key-management';
 
 // Example call that creates 5000 wallets in 10 minutes:
 // VIRTUAL_USERS_GENERATE_DURATION=600 VIRTUAL_USERS_COUNT=5000 yarn load-test-custom:wallet-init
@@ -84,7 +85,15 @@ const createWallet = async (accountIndex: number): Promise<PersonalWallet> => {
   measurementUtil.addMeasureMarker(MeasureTarget.keyAgent, accountIndex);
 
   measurementUtil.addStartMarker(MeasureTarget.wallet, accountIndex);
-  const wallet = new PersonalWallet({ name: `Wallet ${accountIndex}` }, { ...providers, keyAgent, logger });
+  const wallet = new PersonalWallet(
+    { name: `Wallet ${accountIndex}` },
+    {
+      ...providers,
+      addressManager: util.createBip32Ed25519AddressManager(keyAgent),
+      logger,
+      witnesser: util.createBip32Ed25519Witnesser(keyAgent)
+    }
+  );
   walletUtil.initialize(wallet);
   return wallet;
 };

package/test/load-test-custom/wallet-restoration/wallet-restoration.test.ts

@@ -11,10 +11,7 @@ import { PersonalWallet } from '@cardano-sdk/wallet';
 import { logger } from '@cardano-sdk/util-dev';
 import { mapToGroupedAddress } from '../../artillery/wallet-restoration/WalletRestoration';
 
-/**
- * Env var MAX_USERS sets the maximum number of concurrent users to measure
- * default value 100
- */
+/** Env var MAX_USERS sets the maximum number of concurrent users to measure default value 100 */
 const RESTORATION_TIMEOUT = process.env.RESTORATION_TIMEOUT
   ? Number.parseInt(process.env.RESTORATION_TIMEOUT)
   : 5 * MINUTE;

package/test/local-network/register-pool.test.ts

@@ -3,6 +3,7 @@ import { Cardano } from '@cardano-sdk/core';
 import {
   KeyAgentFactoryProps,
   TestWallet,
+  bip32Ed25519Factory,
   getEnv,
   getWallet,
   submitCertificate,
@@ -12,6 +13,7 @@ import {
 } from '../../src';
 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';
 
@@ -40,6 +42,7 @@ const wallet2Params: KeyAgentFactoryProps = {
 describe('local-network/register-pool', () => {
   let wallet1: TestWallet;
   let wallet2: TestWallet;
+  let bip32Ed25519: Crypto.Bip32Ed25519;
 
   beforeAll(async () => {
     jest.setTimeout(180_000);
@@ -63,6 +66,7 @@ describe('local-network/register-pool', () => {
 
     await waitForWalletStateSettle(wallet1.wallet);
     await waitForWalletStateSettle(wallet2.wallet);
+    bip32Ed25519 = await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger);
   });
 
   afterAll(() => {
@@ -75,18 +79,17 @@ describe('local-network/register-pool', () => {
 
     await walletReady(wallet);
 
-    const poolKeyAgent = wallet.keyAgent;
+    const poolAddressManager = wallet.addressManager;
 
-    const poolPubKey = await poolKeyAgent.derivePublicKey({
+    const poolPubKey = await poolAddressManager.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
-    const bip32Ed25519 = await poolKeyAgent.getBip32Ed25519();
     const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
-      await poolKeyAgent.deriveAddress(
+      await poolAddressManager.deriveAddress(
         {
           index: 0,
           type: AddressType.External
@@ -117,13 +120,17 @@ describe('local-network/register-pool', () => {
 
     const rewardAccounts = await firstValueFrom(wallet.delegation.rewardAccounts$);
     const stakeKeyHash = Cardano.RewardAccount.toHash(rewardAccounts[0].address);
+    const stakeCredential = {
+      hash: stakeKeyHash as unknown as Crypto.Hash28ByteBase16,
+      type: Cardano.CredentialType.KeyHash
+    };
 
     await submitCertificate(registrationCert, wallet1);
 
     // Register stake key.
     const registerStakeKey: Cardano.StakeAddressCertificate = {
-      __typename: Cardano.CertificateType.StakeKeyRegistration,
-      stakeKeyHash
+      __typename: Cardano.CertificateType.StakeRegistration,
+      stakeCredential
     };
 
     await submitCertificate(registerStakeKey, wallet1);
@@ -132,7 +139,7 @@ describe('local-network/register-pool', () => {
     const delegationCert: Cardano.StakeDelegationCertificate = {
       __typename: Cardano.CertificateType.StakeDelegation,
       poolId,
-      stakeKeyHash
+      stakeCredential
     };
 
     await submitCertificate(delegationCert, wallet1);
@@ -160,18 +167,17 @@ describe('local-network/register-pool', () => {
 
     await walletReady(wallet);
 
-    const poolKeyAgent = wallet.keyAgent;
+    const poolAddressManager = wallet.addressManager;
 
-    const poolPubKey = await poolKeyAgent.derivePublicKey({
+    const poolPubKey = await poolAddressManager.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
-    const bip32Ed25519 = await poolKeyAgent.getBip32Ed25519();
     const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
-      await poolKeyAgent.deriveAddress(
+      await poolAddressManager.deriveAddress(
         {
           index: 0,
           type: AddressType.External
@@ -202,13 +208,17 @@ describe('local-network/register-pool', () => {
 
     const rewardAccounts = await firstValueFrom(wallet.delegation.rewardAccounts$);
     const stakeKeyHash = Cardano.RewardAccount.toHash(rewardAccounts[0].address);
+    const stakeCredential = {
+      hash: stakeKeyHash as unknown as Crypto.Hash28ByteBase16,
+      type: Cardano.CredentialType.KeyHash
+    };
 
     await submitCertificate(registrationCert, wallet2);
 
     // Register stake key.
     const registerStakeKey: Cardano.StakeAddressCertificate = {
-      __typename: Cardano.CertificateType.StakeKeyRegistration,
-      stakeKeyHash
+      __typename: Cardano.CertificateType.StakeRegistration,
+      stakeCredential
     };
 
     await submitCertificate(registerStakeKey, wallet2);
@@ -217,7 +227,7 @@ describe('local-network/register-pool', () => {
     const delegationCert: Cardano.StakeDelegationCertificate = {
       __typename: Cardano.CertificateType.StakeDelegation,
       poolId,
-      stakeKeyHash
+      stakeCredential
     };
 
     await submitCertificate(delegationCert, wallet2);

package/test/long-running/cache-invalidation.test.ts

@@ -1,8 +1,10 @@
+import * as Crypto from '@cardano-sdk/crypto';
 import { AddressType, KeyRole } from '@cardano-sdk/key-management';
 import { Cardano } from '@cardano-sdk/core';
 import {
   KeyAgentFactoryProps,
   TestWallet,
+  bip32Ed25519Factory,
   getEnv,
   getTxConfirmationEpoch,
   getWallet,
@@ -23,6 +25,7 @@ const vrf = Cardano.VrfVkHex('2ee5a4c423224bb9c42107fc18a60556d6a83cec1d9dd37a71
 describe('cache invalidation', () => {
   let testProviderServer: Docker.Container;
   let wallet1: TestWallet;
+  let bip32Ed25519: Crypto.Bip32Ed25519;
 
   beforeAll(async () => {
     const port = await getRandomPort();
@@ -90,6 +93,7 @@ describe('cache invalidation', () => {
     });
 
     await waitForWalletStateSettle(wallet1.wallet);
+    bip32Ed25519 = await bip32Ed25519Factory.create(env.KEY_MANAGEMENT_PARAMS.bip32Ed25519, null, logger);
   });
 
   afterAll(async () => {
@@ -103,18 +107,17 @@ describe('cache invalidation', () => {
 
     await walletReady(wallet);
 
-    const poolKeyAgent = wallet.keyAgent;
+    const poolAddressManager = wallet.addressManager;
 
-    const poolPubKey = await poolKeyAgent.derivePublicKey({
+    const poolPubKey = await poolAddressManager.derivePublicKey({
       index: 0,
       role: KeyRole.External
     });
 
-    const bip32Ed25519 = await poolKeyAgent.getBip32Ed25519();
     const poolKeyHash = await bip32Ed25519.getPubKeyHash(poolPubKey);
     const poolId = Cardano.PoolId.fromKeyHash(poolKeyHash);
     const poolRewardAccount = (
-      await poolKeyAgent.deriveAddress(
+      await poolAddressManager.deriveAddress(
         {
           index: 0,
           type: AddressType.External

package/test/long-running/multisig-wallet/MultiSigTx.ts

@@ -0,0 +1,117 @@
+import * as Crypto from '@cardano-sdk/crypto';
+import { Cardano, Serialization, deserializeTx } from '@cardano-sdk/core';
+import { HexBlob } from '@cardano-sdk/util';
+
+/**
+ * Represents a multi-signature transaction for the Cardano blockchain.
+ * This transaction can be serialized and transfer between participants of the multisig wallet.
+ * The transaction carries a bit of extra context, such as the expected signers and the signatures
+ * of the signers who have already signed. this way the participants will know if the transaction is ready to be sent,
+ * or they need to relay the transaction to additional participants (and to whom) for additional signing.
+ */
+export class MultiSigTx {
+  #transaction: Cardano.Tx;
+  #expectedSigners: Array<Crypto.Ed25519PublicKeyHex> = [];
+
+  /**
+   * Initializes a new instance of the MultiSigTx class.
+   *
+   * @param {Cardano.Tx} transaction - The underlying Cardano transaction.
+   * @param {Array<Crypto.Ed25519PublicKeyHex>} expectedSigners - An array of expected signers' public keys.
+   */
+  constructor(transaction: Cardano.Tx, expectedSigners: Array<Crypto.Ed25519PublicKeyHex>) {
+    this.#transaction = transaction;
+    this.#expectedSigners = expectedSigners;
+  }
+
+  /**
+   * Serializes the multi-signature transaction to a CBOR hex blob.
+   *
+   * @returns {HexBlob} The serialized transaction as a hex-encoded string.
+   */
+  toCbor(): HexBlob {
+    const writer = new Serialization.CborWriter();
+
+    writer.writeStartArray(2);
+    writer.writeStartArray(this.#expectedSigners.length);
+
+    for (const signer of this.#expectedSigners) {
+      writer.writeByteString(Buffer.from(signer, 'hex'));
+    }
+
+    writer.writeEncodedValue(Buffer.from(Serialization.Transaction.fromCore(this.#transaction).toCbor(), 'hex'));
+    return writer.encodeAsHex();
+  }
+
+  /**
+   * Deserializes a CBOR hex blob into a MultiSigTx instance.
+   *
+   * @param {HexBlob} cbor - The CBOR hex blob representing the transaction.
+   * @returns {MultiSigTx} The deserialized MultiSigTx instance.
+   */
+  static fromCbor(cbor: HexBlob): MultiSigTx {
+    const reader = new Serialization.CborReader(cbor);
+
+    reader.readStartArray();
+    const length = reader.readStartArray();
+    const expectedSigners: Array<Crypto.Ed25519PublicKeyHex> = [];
+
+    if (length === null || length <= 0) throw new Error('Expected at least one signer');
+
+    for (let i = 0; i < length; i++)
+      expectedSigners.push(Crypto.Ed25519PublicKeyHex(Buffer.from(reader.readByteString()).toString('hex')));
+
+    reader.readEndArray();
+
+    const transaction = deserializeTx(reader.readEncodedValue());
+    reader.readEndArray();
+
+    return new MultiSigTx(transaction, expectedSigners);
+  }
+
+  /**
+   * Checks whether the transaction has been fully signed.
+   *
+   * @returns {boolean} True if the transaction is fully signed, otherwise false.
+   */
+  isFullySigned(): boolean {
+    return this.#expectedSigners.every((signer) => this.#transaction.witness.signatures.has(signer));
+  }
+
+  /**
+   * Retrieves the original Cardano transaction.
+   *
+   * @returns {Cardano.Tx} The Cardano transaction.
+   */
+  getTransaction(): Cardano.Tx {
+    return this.#transaction;
+  }
+
+  /**
+   * Identifies and returns the public keys of signers who have not yet signed the transaction.
+   *
+   * @returns {Array<Crypto.Ed25519PublicKeyHex>} An array of public keys of the missing signers.
+   */
+  getMissingSigners(): Array<Crypto.Ed25519PublicKeyHex> {
+    const missingSigners: Array<Crypto.Ed25519PublicKeyHex> = [];
+
+    for (const signer of this.#expectedSigners)
+      if (!this.#transaction.witness.signatures.has(signer)) missingSigners.push(signer);
+
+    return missingSigners;
+  }
+
+  /**
+   * Identifies and returns the public keys of signers who have signed the transaction.
+   *
+   * @returns {Array<Crypto.Ed25519PublicKeyHex>} An array of public keys of the signers who have already signed.
+   */
+  getAccountedForSigners(): Array<Crypto.Ed25519PublicKeyHex> {
+    const accountedSigners: Array<Crypto.Ed25519PublicKeyHex> = [];
+
+    for (const signer of this.#expectedSigners)
+      if (this.#transaction.witness.signatures.has(signer)) accountedSigners.push(signer);
+
+    return accountedSigners;
+  }
+}