@cardano-sdk/e2e 0.16.6-patch.3 → 0.16.7

package/dist/esm/FaucetProvider/types.js

@@ -1,10 +0,0 @@
-export var FaucetRequestTransactionStatus;
-(function (FaucetRequestTransactionStatus) {
-    FaucetRequestTransactionStatus[FaucetRequestTransactionStatus["Pending"] = 0] = "Pending";
-    FaucetRequestTransactionStatus[FaucetRequestTransactionStatus["Submitted"] = 1] = "Submitted";
-    FaucetRequestTransactionStatus[FaucetRequestTransactionStatus["InLedger"] = 2] = "InLedger";
-    FaucetRequestTransactionStatus[FaucetRequestTransactionStatus["Expired"] = 3] = "Expired";
-})(FaucetRequestTransactionStatus || (FaucetRequestTransactionStatus = {}));
-export class FaucetRequestResult {
-}
-//# sourceMappingURL=types.js.map

package/dist/esm/FaucetProvider/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/FaucetProvider/types.ts"],"names":[],"mappings":"AAOA,MAAM,CAAN,IAAY,8BAKX;AALD,WAAY,8BAA8B;IACxC,yFAAO,CAAA;IACP,6FAAS,CAAA;IACT,2FAAQ,CAAA;IACR,yFAAO,CAAA;AACT,CAAC,EALW,8BAA8B,KAA9B,8BAA8B,QAKzC;AAKD,MAAM,OAAO,mBAAmB;CAqB/B"}

package/local-network/faucet/README.md

@@ -1,12 +0,0 @@
-# Create Faucet wallet
-curl http://localhost:8090/v2/wallets -H 'Content-Type: application/json' -H 'Accept: application/json' -d @./faucet/faucet-mnemonic.json
-
-# Get Faucet wallet
-curl http://localhost:8090/v2/wallets/7991322ed68894d0f1fb645a74576c3780ab312c -H 'Content-Type: application/json' -H 'Accept: application/json'
-
-# Transfer Funds from wallet
-curl http://localhost:8090/v2/wallets/7991322ed68894d0f1fb645a74576c3780ab312c/transactions -H 'Content-Type: application/json' -H 'Accept: application/json' -d @./faucet/faucet-send-funds.json
-
-# Track Transaction
-curl http://localhost:8090/v2/wallets/7991322ed68894d0f1fb645a74576c3780ab312c/transactions/927e2e95d78ef331b3b67f0d8f24123e5356972f0589202a725eda690349afa1 -H 'Content-Type: application/json' -H 'Accept: application/json'
-

package/local-network/faucet/faucet-addresses.json

@@ -1,45 +0,0 @@
-[{
-  "id": "addr_test1qqen0wpmhg7fhkus45lyv4wju26cecgu6avplrnm6dgvuk6qel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqh5gd4e",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "0"]
-}, {
-  "id": "addr_test1qqmer3kgnlthg8k4gm9aljmmyfln47cgh2rf8aje5y79eazqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqxzvaqz",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "1"]
-}, {
-  "id": "addr_test1qpxc7yqpqegw7f4pqf9m63ake95k2q9dfqlzhmwkwuell0jqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pq5f4xje",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "2"]
-}, {
-  "id": "addr_test1qpc3gp8ysrapwtax6hdav4s268meg8h8cu8609luzk74xqjqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pq8svsgq",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "3"]
-}, {
-  "id": "addr_test1qqk84jm7tll463syq0gln0q3z4c7rq2mlcwn47uwk22qs4zqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqlpe473",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "4"]
-}, {
-  "id": "addr_test1qphcpmtp2kj78mcu78ezjqnawxzp29yvnh8mdd9ywvw7h56qel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pq4nwldc",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "5"]
-}, {
-  "id": "addr_test1qp3v6hunrj5aj2j78lepl003wttye5znphynx6epmg8m3r6qel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqjejcv4",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "6"]
-}, {
-  "id": "addr_test1qzfawep8h3vls60qudr7zeuhjhv2mrg5sjj5r0yyrs4thr6qel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqqdmtyh",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "7"]
-}, {
-  "id": "addr_test1qzknu4uqjss6sda2jpt9pne95u2mhg82vtfeq4xdxk9jah2qel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqfv2ftn",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "8"]
-}, {
-  "id": "addr_test1qpx986ct0jrqdhs924s5qsk629vuzw7mpadmwke7hsk3z5zqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqmhx5xw",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "9"]
-}, {
-  "id": "addr_test1qrlmds0rl093pg2ywtqr4p5hjagm40a397r8whalwqmw4czqel5hu3u3q0fht53ly97yx95hkt56j37ch07pesf6s4pqz45ud0",
-  "state": "unused",
-  "derivation_path": ["1852H", "1815H", "0H", "0", "10"]
-}]

package/local-network/faucet/faucet-mnemonic.json

@@ -1,6 +0,0 @@
-{
-	"name": "Faucet",
-	"mnemonic_sentence": ["fire", "method", "repair", "aware", "foot", "tray", "accuse", "brother", "popular", "olive", "find", "account", "sick", "rocket", "next"],
-	"passphrase": "passphrase",
-	"address_pool_gap": 20
-}

package/local-network/faucet/faucet-send-funds.json

@@ -1,23 +0,0 @@
-{
-	"passphrase": "passphrase",
-	"payments": [{
-		"address": "addr_test1vrgylrse49du60jdy7h46mg5mwft6kw8r0l4v5pklkj324cm247gf",
-		"amount": {
-			"quantity": 42000000,
-			"unit": "lovelace"
-		},
-		"assets": []
-	}],
-	"withdrawal": "self",
-	"metadata": {
-		"0": {},
-		"1": {},
-		"2": {},
-		"3": {},
-		"4": {}
-	},
-	"time_to_live": {
-		"quantity": 10,
-		"unit": "second"
-	}
-}

package/local-network/scripts/is-faucet-ready.sh

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-
-here="$(cd "$(dirname "$0")" >/dev/null 2>&1 && pwd)"
-root="$(cd "$here/.." && pwd)"
-
-cd "$root"
-
-export PATH=$PWD/bin:$PATH
-
-WALLET_ID="7991322ed68894d0f1fb645a74576c3780ab312c"
-PORT=8090
-FAUCET_WALLET='{"name": "Faucet", "mnemonic_sentence": ["fire", "method", "repair", "aware", "foot", "tray", "accuse", "brother", "popular", "olive", "find", "account", "sick", "rocket", "next"], "passphrase": "passphrase", "address_pool_gap": 20 }'
-
-# Add Faucet wallet
-curl -s http://localhost:"$PORT"/v2/wallets -H 'Content-Type: application/json' -H 'Accept: application/json' -d "$FAUCET_WALLET" > /dev/null
-
-# Get wallet status
-status=$(curl -s http://localhost:"$PORT"/v2/wallets/"$WALLET_ID" -H 'Content-Type: application/json' -H 'Accept: application/json' | jq .state.status)
-epoch=$(curl -s http://localhost:"$PORT"/v2/wallets/"$WALLET_ID" -H 'Content-Type: application/json' -H 'Accept: application/json' | jq .tip.epoch_number)
-totalBalance=$(curl -s http://localhost:"$PORT"/v2/wallets/"$WALLET_ID" -H 'Content-Type: application/json' -H 'Accept: application/json' | jq .balance.total.quantity)
-
-if [[ "$status" == "\"ready\"" && $epoch -gt 4 && $totalBalance -gt 100000000 ]]; then # Faucet will be marked unhealthy if 100 or less tADA remains in the faucet wallet (initial balance is 13.5 billion tADA)
-  exit 0
-fi
-
-exit 9
-

package/src/FaucetProvider/index.ts

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './providers/cardanoWalletFaucetProvider';

package/src/FaucetProvider/providers/cardanoWalletFaucetProvider.ts

@@ -1,233 +0,0 @@
-import {
-  AddressWallet,
-  ApiNetworkInformationSyncProgressStatusEnum,
-  ApiTransactionStatusEnum,
-  TransactionWallet,
-  WalletServer
-} from 'cardano-wallet-js';
-import { Cardano, HealthCheckResponse } from '@cardano-sdk/core';
-import { FaucetProvider, FaucetRequestResult, FaucetRequestTransactionStatus } from '../types';
-import { Stopwatch } from 'ts-stopwatch';
-import Process from 'process';
-
-// Constants
-const FAUCET_PASSPHRASE = 'passphrase';
-const FAUCET_WALLET_NAME = 'faucet';
-const HTTP_ERROR_CODE_IN_CONFLICT = 409;
-const DEFAULT_TIMEOUT = 10_000;
-const DEFAULT_CONFIRMATIONS = 0;
-const PARAM_NAME_URL = 'baseUrl';
-const PARAM_NAME_MNEMONICS = 'mnemonic';
-
-const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
-
-/**
- * Cardano Wallet implementation of the faucet provider. This provider utlizes the Cardano Wallet HTTP service
- * to construct, sign, submit and track the transaction generated by the faucet.
- */
-export class CardanoWalletFaucetProvider implements FaucetProvider {
-  #serviceUrl = '';
-  #seedPhrases = '';
-  #faucetWalletId = '';
-  #walletServer: WalletServer;
-
-  /**
-   * Initializes a new instance of the CardanoWalletFaucetService class.
-   *
-   * @param url The cardano wallet server REST endpoint.
-   * @param seedPhrases The seedphrases of the faucet wallet.
-   */
-  constructor(url: string, seedPhrases: string) {
-    this.#serviceUrl = url;
-    this.#seedPhrases = seedPhrases;
-  }
-
-  /**
-   * Request tAda to be transferred to a single given address.
-   *
-   * @param address The address where the tAda must be deposited.
-   * @param amount The amount of tAda to be deposited at the given address address (in lovelace).
-   * @param confirmations The number of blocks that has passed since our transaction was added to the blockchain.
-   * @param timeout The time we are willing to wait (in milliseconds) for the faucet request
-   *                transaction to be confirmed.
-   */
-  public async request(
-    address: string,
-    amount: number,
-    confirmations: number = DEFAULT_CONFIRMATIONS,
-    timeout: number = DEFAULT_TIMEOUT
-  ): Promise<FaucetRequestResult> {
-    return this.multiRequest([address], [amount], confirmations, timeout);
-  }
-
-  /**
-   * Request tAda to be transferred to the given address.
-   *
-   * @param addresses The addresses where the tAda must be deposited.
-   * @param amounts The amounts of tAda to be deposited at each address (in lovelace).
-   * @param confirmations The number of blocks that has passed since our transaction was added to the blockchain.
-   * @param timeout The time we are willing to wait (in milliseconds) for the faucet request
-   *                transaction to be confirmed.
-   */
-  public async multiRequest(
-    addresses: string[],
-    amounts: number[],
-    confirmations: number = DEFAULT_CONFIRMATIONS,
-    timeout: number = DEFAULT_TIMEOUT
-  ): Promise<FaucetRequestResult> {
-    const faucetWallet = await this.#walletServer.getShelleyWallet(this.#faucetWalletId);
-
-    const receiverAddress = addresses.map((strAddress) => new AddressWallet(strAddress));
-
-    const stopwatch = new Stopwatch();
-    stopwatch.start();
-
-    let transaction: TransactionWallet = await faucetWallet.sendPayment(FAUCET_PASSPHRASE, receiverAddress, amounts);
-
-    let isTransactionConfirmed = false;
-    while (
-      (transaction.status === ApiTransactionStatusEnum.Pending || !isTransactionConfirmed) &&
-      stopwatch.getTime() < timeout
-    ) {
-      transaction = await faucetWallet.getTransaction(transaction.id);
-      isTransactionConfirmed = transaction.depth !== undefined && transaction.depth.quantity >= confirmations;
-    }
-
-    stopwatch.stop();
-
-    if (stopwatch.getTime() >= timeout) throw new Error(`The transaction ${transaction.id} was not confirmed on time`);
-
-    return {
-      confirmations: transaction.depth?.quantity,
-      id: Cardano.TransactionId(transaction.id),
-      status: this.mapStatus(transaction.status),
-      time: transaction.inserted_at?.time
-    };
-  }
-
-  /**
-   * Starts the provider.
-   */
-  public async start(): Promise<void> {
-    const walletInfo = {
-      mnemonic_sentence: this.#seedPhrases.split(' '),
-      name: FAUCET_WALLET_NAME,
-      passphrase: FAUCET_PASSPHRASE
-    };
-
-    this.#walletServer = WalletServer.init(this.#serviceUrl);
-
-    const axiosResponse = await this.#walletServer.walletsApi.postWallet(walletInfo).catch((error) => {
-      if (error.response === undefined) throw error;
-
-      // This seed phrases already exists on the cardano wallet service.
-      if (error.response.status === HTTP_ERROR_CODE_IN_CONFLICT) {
-        // TODO: If the seedphrases were already added to Cardano Wallet, the id of the wallet
-        // will be returned in an error message, we can then extract the id from the message, however
-        // this extremely brittle. We must find a better way to get the wallet id given a set of seed phrases.
-        this.#faucetWalletId = error.response.data.message.match(/(?<=: ).*(?= H)/g)[0];
-      } else {
-        throw error.response.data;
-      }
-    });
-
-    if (axiosResponse) this.#faucetWalletId = axiosResponse.data.id;
-
-    const start = Date.now() / 1000;
-    const waitTime = Process.env.LOCAL_NETWORK_READY_WAIT_TIME ? Process.env.LOCAL_NETWORK_READY_WAIT_TIME : 1200;
-    let isReady = false;
-    let currentElapsed = 0;
-
-    while (!isReady && currentElapsed < waitTime) {
-      try {
-        isReady = (await this.healthCheck()).ok;
-      } catch {
-        // continue
-      } finally {
-        currentElapsed = Date.now() / 1000 - start;
-        await sleep(5000);
-      }
-    }
-
-    if (currentElapsed > waitTime) {
-      throw new Error('Wait time expired. The faucet was not ready on time.');
-    }
-  }
-
-  /**
-   * Gets the remaining balance on the faucet.
-   */
-  public async getBalance(): Promise<number> {
-    if (this.#faucetWalletId === undefined) throw new Error('Faucet is not running.');
-
-    const axiosResponse = await this.#walletServer.walletsApi.getWallet(this.#faucetWalletId);
-    return axiosResponse.data.balance.total.quantity;
-  }
-
-  /**
-   * Closes the provider.
-   */
-  public async close(): Promise<void> {
-    this.#faucetWalletId = '';
-  }
-
-  /**
-   * Performs a health check on the provider.
-   *
-   * @returns A promise with the healthcheck reponse.
-   */
-  public async healthCheck(): Promise<HealthCheckResponse> {
-    const networkInfo = await this.#walletServer.getNetworkInformation();
-
-    return {
-      ok:
-        networkInfo.sync_progress.status === ApiNetworkInformationSyncProgressStatusEnum.Ready &&
-        this.#faucetWalletId !== '' &&
-        (await this.getBalance()) > 100_000_000 // Faucet must have more than 100 tADA to be considered healthy
-    };
-  }
-
-  /**
-   * Converts the cardano wallet transaction result enum to our FaucetRequestTransactionStatus enum.
-   *
-   * @param status The cardano wallet enum to be converted.
-   * @returns The FaucetRequestTransactionStatus equivalent enum value.
-   */
-  private mapStatus(status: ApiTransactionStatusEnum): FaucetRequestTransactionStatus {
-    let mappedStatus: FaucetRequestTransactionStatus = FaucetRequestTransactionStatus.Expired;
-    switch (status) {
-      case ApiTransactionStatusEnum.Expired:
-        mappedStatus = FaucetRequestTransactionStatus.Expired;
-        break;
-      case ApiTransactionStatusEnum.InLedger:
-        mappedStatus = FaucetRequestTransactionStatus.InLedger;
-        break;
-      case ApiTransactionStatusEnum.Pending:
-        mappedStatus = FaucetRequestTransactionStatus.Pending;
-        break;
-    }
-
-    return mappedStatus;
-  }
-
-  /**
-   * Create a new faucet provider.
-   *
-   * @param params The parameters to be passed to the concrete implementation constructor.
-   * @returns The new Faucet provider.
-   * @throws if The give provider name is not registered, or the constructor parameters of
-   *         the providers are either missing or invalid.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public static create(params: any): Promise<FaucetProvider> {
-    if (!params.hasOwnProperty(PARAM_NAME_URL))
-      throw new Error(`${CardanoWalletFaucetProvider.name} missing argument: ${PARAM_NAME_URL}`);
-
-    if (!params.hasOwnProperty(PARAM_NAME_MNEMONICS))
-      throw new Error(`${CardanoWalletFaucetProvider.name} missing argument: ${PARAM_NAME_MNEMONICS}`);
-
-    return new Promise<FaucetProvider>((resolve) => {
-      resolve(new CardanoWalletFaucetProvider(params[PARAM_NAME_URL], params[PARAM_NAME_MNEMONICS]));
-    });
-  }
-}

package/src/FaucetProvider/types.ts

@@ -1,94 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import { Cardano, HealthCheckResponse, Provider } from '@cardano-sdk/core';
-
-/**
- * Faucet request transaction status.
- */
-export enum FaucetRequestTransactionStatus {
-  Pending,
-  Submitted,
-  InLedger,
-  Expired
-}
-
-/**
- * Result for a faucet request.
- */
-export class FaucetRequestResult {
-  /**
-   * The transaction id of the transaction generated by this request.
-   */
-  id: Cardano.TransactionId;
-
-  /**
-   * Current status of the transaction generated by this request in the local chain .
-   */
-  status: FaucetRequestTransactionStatus;
-
-  /**
-   * Absolute time at which the transaction generated by this reuqest was inserted in a block.
-   */
-  time: string;
-
-  /**
-   * How many blocks has passed since our transaction was added to the Cardano blockchain. The more
-   * confirmations that have occured, the more secure the transaction is.
-   */
-  confirmations: number;
-}
-
-/**
- * The faucet provider enable clients to request arbitrary amounts of tAda from current local network
- * to fund any address. This is useful for the setup of preconditions for end-to-end tests.
- */
-export interface FaucetProvider extends Provider {
-  /**
-   * Request tAda to be transferred to a single given address.
-   *
-   * @param address The address where the tAda must be deposited.
-   * @param amount  The amount of tAda to be deposited at the given address address (in lovelace).
-   * @param timeout The time we are willing to wait (in milliseconds) for the faucet request
-   *                transaction to be confirmed.
-   * @param confirmations The number of blocks that has passed since our transaction was added to the blockchain.
-   */
-  request(address: string, amount: number, confirmations?: number, timeout?: number): Promise<FaucetRequestResult>;
-
-  /**
-   * Request tAda to be transferred to several given addresses.
-   *
-   * @param addresses The addresses where the tAda must be deposited.
-   * @param amounts   The amounts of tAda to be deposited at each address (in lovelace).
-   * @param timeout   The time we are willing to wait (in milliseconds) for the faucet request
-   *                  transaction to be confirmed.
-   * @param confirmations The number of blocks that has passed since our transaction was added to the blockchain.
-   */
-  multiRequest(
-    addresses: string[],
-    amounts: number[],
-    confirmations?: number,
-    timeout?: number
-  ): Promise<FaucetRequestResult>;
-
-  /**
-   * Initializes the faucet provider.
-   */
-  start(): Promise<void>;
-
-  /**
-   * Finalizes the faucet provider.
-   */
-  close(): Promise<void>;
-
-  /**
-   * Gets the remaining balance on the faucet.
-   */
-  getBalance(): Promise<number>;
-
-  /**
-   * Performs a health check on the provider.
-   *
-   * @returns A promise with the healthcheck reponse.
-   */
-  healthCheck(): Promise<HealthCheckResponse>;
-}