@kyve/core/src/methods/validateBundleProposal.ts

🚀 The base KYVE node implementation.

import { Node } from "..";
import { sleep, standardizeJSON, sha256 } from "../utils";
import { VOTE } from "../utils/constants";
import { DataItem } from "../types";

export async function validateBundleProposal(
  this: Node,
  createdAt: number
): Promise<void> {
  this.logger.info(
    `Validating bundle "${this.pool.bundle_proposal!.storage_id}"`
  );

  let hasVotedAbstain = this.pool.bundle_proposal?.voters_abstain.includes(
    this.client.account.address
  );

  let proposedBundle: DataItem[] = [];
  let proposedBundleCompressed: Buffer;

  let validationBundle: DataItem[] = [];

  while (true) {
    await this.syncPoolState();

    if (+this.pool.bundle_proposal!.created_at > createdAt) {
      // check if new proposal is available in the meantime
      return;
    } else if (this.shouldIdle()) {
      // check if pool got paused in the meantime
      return;
    }

    // try to download bundle from arweave
    if (!proposedBundleCompressed!) {
      this.logger.debug(
        `Attempting to download bundle from ${this.storageProvider.name}`
      );

      try {
        proposedBundleCompressed = await this.storageProvider.retrieveBundle(
          this.pool.bundle_proposal!.storage_id
        );
      } catch (error) {
        this.logger.warn(
          ` Failed to retrieve bundle from ${this.storageProvider.name}. Retrying in 10s ...\n`
        );
        if (!hasVotedAbstain) {
          await this.voteBundleProposal(
            this.pool.bundle_proposal!.storage_id,
            VOTE.ABSTAIN
          );
          hasVotedAbstain = true;
        }

        await sleep(10 * 1000);
        continue;
      }

      if (proposedBundleCompressed!) {
        this.logger.info(
          `Successfully downloaded bundle from ${this.storageProvider.name}`
        );

        try {
          proposedBundle = await this.compression.decompress(
            proposedBundleCompressed
          );
          this.logger.info(
            `Successfully decompressed bundle with compression type ${this.compression.name}`
          );
        } catch (error) {
          this.logger.info(
            `Could not decompress bundle with compression type ${this.compression.name}`
          );
        }
      } else {
        this.logger.info(
          `Could not download bundle from ${this.storageProvider.name}. Retrying in 10s ...`
        );

        if (!hasVotedAbstain) {
          await this.voteBundleProposal(
            this.pool.bundle_proposal!.storage_id,
            VOTE.ABSTAIN
          );
          hasVotedAbstain = true;
        }

        await sleep(10 * 1000);
        continue;
      }
    }

    // try to load local bundle
    const currentHeight = +this.pool.current_height;
    const toHeight = +this.pool.bundle_proposal!.to_height || currentHeight;

    this.logger.debug(
      `Attemping to load local bundle from ${currentHeight} to ${toHeight} ...`
    );

    const { bundle } = await this.loadBundle(currentHeight, toHeight);

    // check if bundle length is equal to request bundle
    if (bundle.length === toHeight - currentHeight) {
      validationBundle = bundle;

      this.logger.info(
        `Successfully loaded local bundle from ${currentHeight} to ${toHeight}\n`
      );

      break;
    } else {
      this.logger.info(
        `Could not load local bundle from ${currentHeight} to ${toHeight}. Retrying in 10s ...`
      );

      if (!hasVotedAbstain) {
        await this.voteBundleProposal(
          this.pool.bundle_proposal!.storage_id,
          VOTE.ABSTAIN
        );
        hasVotedAbstain = true;
      }

      await sleep(10 * 1000);
      continue;
    }
  }

  try {
    const uploadedBundleHash = sha256(standardizeJSON(proposedBundle));
    const proposedBundleHash = this.pool.bundle_proposal!.bundle_hash;
    const validationBundleHash = sha256(standardizeJSON(validationBundle));

    const uploadedByteSize = proposedBundleCompressed.byteLength;
    const proposedByteSize = +this.pool.bundle_proposal!.byte_size;

    const uploadedKey = proposedBundle!.at(-1)?.key ?? "";
    const proposedKey = this.pool.bundle_proposal!.to_key;

    const uploadedValue = await this.runtime.formatValue(
      proposedBundle!.at(-1)?.value ?? ""
    );
    const proposedValue = this.pool.bundle_proposal!.to_value;

    this.logger.debug(`Validating bundle proposal by hash and byte size`);
    this.logger.debug(`Uploaded:     ${uploadedBundleHash}`);
    this.logger.debug(`Proposed:     ${proposedBundleHash}`);
    this.logger.debug(`Validation:   ${validationBundleHash}\n`);

    this.logger.debug(`Validating bundle proposal by byte size, key and value`);
    this.logger.debug(
      `Uploaded:     ${uploadedByteSize} ${uploadedKey} ${uploadedValue}`
    );
    this.logger.debug(
      `Proposed:     ${proposedByteSize} ${proposedKey} ${proposedValue}\n`
    );

    let hashesEqual = false;
    let byteSizesEqual = false;
    let keysEqual = false;
    let valuesEqual = false;

    if (
      uploadedBundleHash === proposedBundleHash &&
      proposedBundleHash === validationBundleHash
    ) {
      hashesEqual = true;
    }

    if (uploadedByteSize === proposedByteSize) {
      byteSizesEqual = true;
    }

    if (uploadedKey === proposedKey) {
      keysEqual = true;
    }

    if (uploadedValue === proposedValue) {
      valuesEqual = true;
    }

    if (keysEqual && valuesEqual && byteSizesEqual && hashesEqual) {
      await this.voteBundleProposal(
        this.pool.bundle_proposal!.storage_id,
        VOTE.VALID
      );
    } else {
      await this.voteBundleProposal(
        this.pool.bundle_proposal!.storage_id,
        VOTE.INVALID
      );
    }
  } catch (error) {
    this.logger.warn(` Failed to validate bundle`);
    this.logger.debug(error);

    if (!hasVotedAbstain) {
      await this.voteBundleProposal(
        this.pool.bundle_proposal!.storage_id,
        VOTE.ABSTAIN
      );
    }
  }
}