@test-org122/hypernet-core/src/interfaces/business/IControlService.ts

Hypernet Core. Represents the SDK for running the Hypernet Protocol.

import { ControlClaim, ResultAsync } from "@interfaces/objects";
import {
  BlockchainUnavailableError,
  CoreUninitializedError,
  LogicalError,
  ThreeBoxError,
} from "@interfaces/objects/errors";

/**
 * @todo What is the main role/purpose of this class? Description here.
 */
export interface IControlService {
  /**
   * Should be called after the Hypernet Core is ready to assume control
   * of an account.
   * @todo Describe the purpose of this function - what does it do?
   */
  claimControl(): ResultAsync<void, CoreUninitializedError | BlockchainUnavailableError | ThreeBoxError | LogicalError>;

  /**
   * Processes an incoming control claim. Basically just yields control.
   */
  processControlClaim(controlClaim: ControlClaim): ResultAsync<void, CoreUninitializedError>;
}