testweave-sdk/src/classes/class.testweave-utils.ts

This is the SDK of TestWeave. TestWeave is the testing environment of the Arweave.

import Arweave from 'arweave';
import { JWKInterface } from 'arweave/node/lib/wallet';
import rootJWK from '../assets/arweave-keyfile-MlV6DeOtRmakDOf6vgOBlif795tcWimgyPsYYNQ8q1Y.json';
import ITestWeaveUtils from '../interfaces/interface.testweave-utils';
import TestWeaveTransactionsManager from './class.testweave-transactions-manager';

export default class TestWeaveUtils implements ITestWeaveUtils {
  private _arweave: Arweave;
  /**
   * The constructor of the class. Should never be called directly, since this
   * is a static class.
   * @param arweaveInstance an arweave instance.
   */
  private constructor(arweaveInstance: Arweave) {
    this._arweave = arweaveInstance;
  }
  /**
   * Returns a TestWeave instance
   * @param arweaveInstance the arweave instance on the top of with the TestWeave must be created. The instance should be created with arweave.init().
   * @returns a TestWeave instance.
  */
  public static init(
    arweaveInstance: Arweave,
  ): TestWeaveUtils {
    return new TestWeaveUtils(arweaveInstance);
  }

  /**
   * Returns the JWK of the root address
   * @returns JWKInterface the JWK of the root address
   */
  public getRootJWK(): JWKInterface {
    return rootJWK;
  }

  /**
   * Drops the given winston from the root JWK to the given address.
   * @param targetAddress the address to which drop the winston
   * @param winstonBalance the amount of winston that must be dropped
   * @param transactionsPool the array containing the transactions pool
   */
  public async dropFromRootAddress(targetAddress:string, winstonBalance: string, transactionsManager: TestWeaveTransactionsManager): Promise<string> {
    const transaction = await this._arweave.createTransaction({
      target: targetAddress,
      quantity: winstonBalance
    }, this.getRootJWK());
    await this._arweave.transactions.sign(transaction, rootJWK)
    await this._arweave.transactions.post(transaction);
    const minedTransactions = await this.mine(transactionsManager);
    return minedTransactions[0];
  }

  /**
   * Mines a new block in the TestWeave Network
   * @returns the axios response created around the call to the /mine endpoint
  */
  public async mine(transactionManager: TestWeaveTransactionsManager): Promise<Array<string>> {
    // check if there are transactions in the pool that are not yet inserted in the tx/ready_for_mining
    const resolvedTransactions:Array<string> = await transactionManager.resolvePool();
    return resolvedTransactions;
  }

  /**
   * Utility function to stop execution for a specific amount of time.
   * @param ms the amount of ms for which the execution must be stopped
   */
  public async delay(ms: number): Promise<void> {
    return new Promise(res => setTimeout(res, ms));
  }
}