Class EvmProgramOpsAdminService

constructor

• new EvmProgramOpsAdminService(
      __namedParameters: {
          backgroundTemporalClient: FeeRecordClient;
          db: B2bDatabase;
          internalEventPublisher: Pick<InternalEventPublisher, "publishConfirmed">;
          register: Pick<EvmProgramAdminService, "search" | "get">;
          releases: EvmReleaseClient;
          rpc: EvmRpcClient;
          walletApiClient: Pick<WalletApiClient, "sendEvmTransaction">;
          walletDeployClient: Pick<WalletApiClient, "evmDeploy">;
      },
  ): EvmProgramOpsAdminService

  Parameters

  • __namedParameters: {
        backgroundTemporalClient: FeeRecordClient;
        db: B2bDatabase;
        internalEventPublisher: Pick<InternalEventPublisher, "publishConfirmed">;
        register: Pick<EvmProgramAdminService, "search" | "get">;
        releases: EvmReleaseClient;
        rpc: EvmRpcClient;
        walletApiClient: Pick<WalletApiClient, "sendEvmTransaction">;
        walletDeployClient: Pick<WalletApiClient, "evmDeploy">;
    }

    • backgroundTemporalClient: FeeRecordClient

      background-<env>, where revertedSendFeeWorkflow records a FAILED send's gas.

    • db: B2bDatabase

    • internalEventPublisher: Pick<InternalEventPublisher, "publishConfirmed">

    • register: Pick<EvmProgramAdminService, "search" | "get">

    • releases: EvmReleaseClient

    • rpc: EvmRpcClient

    • walletApiClient: Pick<WalletApiClient, "sendEvmTransaction">

      The signing function: resumes a stored row with transaction.send.

    • walletDeployClient: Pick<WalletApiClient, "evmDeploy">

      The deploy function (cfx-wallet-deploy), the only one serving the deploy and timelock ops.

  Returns EvmProgramOpsAdminService

Staticinstance

creationCodeHash

• creationCodeHash(
      __namedParameters: { contract: EvmUpgradeable; release: string },
  ): Promise<
      { ok: true; value: `0x${string}` }
      | { error: ServiceError; ok: false },
  >

  The creation code hash an op must name, read from the release manifest.

  Parameters

  • __namedParameters: { contract: EvmUpgradeable; release: string }

  Returns Promise<{ ok: true; value: `0x${string}` } | { error: ServiceError; ok: false }>

executionCodeHash

• executionCodeHash(
      __namedParameters: {
          chainId: number;
          proxy: EvmUpgradeable;
          release: string;
      },
  ): Promise<
      { ok: true; value: `0x${string}` }
      | { error: ServiceError; ok: false },
  >

  The hash an operator's retry executes with, past the checks the sweep makes before its own execute, so that a retry is no way round them.

  Parameters

  • __namedParameters: { chainId: number; proxy: EvmUpgradeable; release: string }

  Returns Promise<{ ok: true; value: `0x${string}` } | { error: ServiceError; ok: false }>

planDeploy

• planDeploy(
      __namedParameters: { chainId: number },
  ): Promise<
      { ok: true; value: EvmDeployPlan }
      | { error: RunError; ok: false },
  >

  Refuses a chain that cannot be deployed before anything is sent.

  Parameters

  • __namedParameters: { chainId: number }

  Returns Promise<{ ok: true; value: EvmDeployPlan } | { error: RunError; ok: false }>

runStep

• runStep(
      __namedParameters: {
          chainId: number;
          reference: string;
          step: EvmOpStep;
      },
  ): Promise<
      | {
          ok: true;
          value: { alreadyDeployed: boolean; walletTransactionId: string
          | null };
      }
      | {
          error: | ServiceError<"WORKFLOW_ID_HELD">
          | WalletApiEvmError
          | ServiceError<"EVM_STEP_FAILED" | "EVM_STEP_IN_FLIGHT">;
          ok: false;
      },
  >

  One wallet-api op, followed until confirmed. Idempotent: wallet-api answers a repeated reference from its row and a landed result from the chain.

  Parameters

  • __namedParameters: { chainId: number; reference: string; step: EvmOpStep }

  Returns Promise<
      | {
          ok: true;
          value: { alreadyDeployed: boolean; walletTransactionId: string
          | null };
      }
      | {
          error: | ServiceError<"WORKFLOW_ID_HELD">
          | WalletApiEvmError
          | ServiceError<"EVM_STEP_FAILED" | "EVM_STEP_IN_FLIGHT">;
          ok: false;
      },
  >

searchSweepSlots

• searchSweepSlots(): Promise<{ ok: true; value: EvmSweepSlot[] }>

  Every slot on this stage that wallet-api can have written.

  Returns Promise<{ ok: true; value: EvmSweepSlot[] }>

sweepSlot

• sweepSlot(
      target: EvmSweepSlot,
  ): Promise<{ ok: true; value: EvmSweepSlotResult }>

  One run over one slot: follows its live rows, then executes a ready upgrade. Never executes a delay change. An issue is returned, not thrown, so the caller reports it and the other slots still run.

  Parameters

  • target: EvmSweepSlot

  Returns Promise<{ ok: true; value: EvmSweepSlotResult }>

verifyDeploy

• verifyDeploy(
      __namedParameters: { chainId: number },
  ): Promise<
      | { ok: true; value: void }
      | {
          error:
              | ServiceError<"GITHUB_ERROR", { status: number }>
              | ServiceError<"EVM_VERIFY_FAILED">;
          ok: false;
      },
  >

  Every contract on the chain deployed and matching a release.

  Parameters

  • __namedParameters: { chainId: number }

  Returns Promise<
      | { ok: true; value: void }
      | {
          error:
              | ServiceError<"GITHUB_ERROR", { status: number }>
              | ServiceError<"EVM_VERIFY_FAILED">;
          ok: false;
      },
  >

verifyUpgrade

• verifyUpgrade(
      __namedParameters: {
          chainId: number;
          proxy: EvmUpgradeable;
          release: string;
      },
  ): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>

  The proxy runs release: the slot and the runtime hash both, through the register.

  Parameters

  • __namedParameters: { chainId: number; proxy: EvmUpgradeable; release: string }

  Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>