gate-evm-tools 1.0.26 → 1.0.28

package/dist-runtime/workflow/lib/migrationState.d.ts

@@ -0,0 +1,103 @@
+import { type ContractInfo } from "./deployments";
+export type MigrationReleaseStage = "development" | "production";
+export type MigrationProxyKind = "none" | "uups" | "transparent";
+export interface MigrationContractPlan {
+    instanceId: string;
+    contractInfoKey: string;
+    address: string;
+    actualContract: string;
+    proxyKind: MigrationProxyKind;
+    implementationAddress?: string;
+}
+export interface MigrationNetworkPlan {
+    sourceNetwork: string;
+    releaseStage: MigrationReleaseStage;
+    chainId: number;
+    manifestDir: string;
+    contracts: MigrationContractPlan[];
+}
+export interface MigrationStatePlan {
+    version: 1;
+    migrationId: string;
+    sourceProject: string;
+    networks: Record<string, MigrationNetworkPlan>;
+}
+export interface MigrationInspection {
+    chainId: number;
+    hasCode: boolean;
+    artifactExists: boolean;
+    proxyKind: MigrationProxyKind;
+    implementationAddress?: string;
+    address?: string;
+}
+export interface MigrationImportEvidence {
+    version: 1;
+    status: "imported";
+    integrityHash: string;
+    migrationId: string;
+    sourceProject: string;
+    planHash: string;
+    contractInfoHash: string;
+    deploymentInfoHash: string;
+    networks: Record<string, {
+        sourceNetwork: string;
+        releaseStage: MigrationReleaseStage;
+        chainId: number;
+        manifestDir: string;
+        contracts: number;
+    }>;
+    confirmations: string[];
+    bytecodeCheck: {
+        status: "passed";
+        reportPath: string;
+        reportHash: string;
+    };
+    before: {
+        contractInfoHash: string;
+        deploymentInfoHash: string;
+    };
+    importedAt: string;
+}
+export interface MigrationTargetConfig {
+    environment: string;
+    openzeppelin?: {
+        manifestDir?: unknown;
+    };
+}
+export interface MigrationStateIo {
+    writeJson?(filePath: string, value: unknown, options?: {
+        exclusive?: boolean;
+    }): void;
+    rename?(sourcePath: string, targetPath: string): void;
+    afterRename?(sourcePath: string, targetPath: string, index: number): void;
+}
+export interface ImportMigrationStateOptions {
+    root: string;
+    plan: unknown;
+    targets: Record<string, MigrationTargetConfig>;
+    confirmations: string[];
+    inspect: (network: string, contract: MigrationContractPlan) => Promise<MigrationInspection> | MigrationInspection;
+    verifyCandidate: (contractInfo: ContractInfo) => Promise<{
+        status: "passed" | "failed";
+        report: unknown;
+    }>;
+    now?: () => string;
+    io?: MigrationStateIo;
+}
+export declare const validateMigrationStatePlan: (value: unknown) => MigrationStatePlan;
+export declare const migrationConfirmationToken: (inputPlan: unknown, network: string) => string;
+export declare const validateMigrationImportEvidence: (value: unknown) => MigrationImportEvidence;
+export declare const resolveConfinedMigrationPath: (root: string, requested: string, options?: {
+    label?: string;
+    requireFile?: boolean;
+}) => string;
+export declare const resolveGateToolCandidateCheck: (result: {
+    status: number | null;
+    error?: {
+        message?: unknown;
+    };
+}, reportPath: string) => {
+    status: "passed" | "failed";
+    report: unknown;
+};
+export declare const importMigrationState: (options: ImportMigrationStateOptions) => Promise<MigrationImportEvidence>;