@layerzerolabs/verify-contract 1.1.0 → 1.1.3

package/dist/index.d.mts

@@ -1,24 +1,94 @@
 import { Logger } from 'winston';
 
-type NetworkName = string;
+declare enum LicenseType {
+    None = 1,
+    Unlicense = 2,
+    MIT = 3,
+    "GNU-GPLv2" = 4,
+    "GNU-GPLv3" = 5,
+    "GNU-LGPLv2.1" = 6,
+    "GNU-LGPLv3" = 7,
+    "BSD-2-Clause" = 8,
+    "BSD-3-Clause" = 9,
+    "MPL-2.0" = 10,
+    "OSL-3.0" = 11,
+    "Apache-2.0" = 12,
+    "GNU-AGPLv3" = 13,
+    "BUSL-1.1" = 14
+}
 
-interface VerifyHardhatDeployPathsConfig {
-    deployments: string;
+interface SubmitForVerificationProps {
+    apiKey?: string;
+    apiUrl: string;
+    address: string;
+    contractName: string;
+    compilerVersion: string;
+    optimizerRuns?: number;
+    licenseType?: LicenseType;
+    sourceCode: string;
+    constructorArguments?: string;
+    evmVersion?: string;
+}
+interface VerificationResponse {
+    alreadyVerified: boolean;
 }
-interface VerifyHardhatDeploysNetworkConfig {
+
+type NetworkName = string;
+interface NetworkConfig {
     apiUrl: string;
     apiKey?: string;
     browserUrl?: string;
 }
-type VerifyHardhatDeployFilterConfig = boolean | string | string[] | RegExp | VerifyHardhatDeployFilterConfigFunction;
-type VerifyHardhatDeployFilterConfigFunction = (name: string, path: string, networkName: NetworkName) => boolean;
-interface VerifyHardhatDeploysConfig {
-    paths?: Partial<VerifyHardhatDeployPathsConfig>;
-    networks?: Record<NetworkName, Partial<VerifyHardhatDeploysNetworkConfig>>;
-    verify?: VerifyHardhatDeployFilterConfig;
+
+interface VerifyHardhatPathsConfig {
+    deployments: string;
+}
+type VerifyHardhatFilterConfig = boolean | string | string[] | RegExp | VerifyHardhatFilterFunction;
+type VerifyHardhatFilterFunction = (name: string, path: string, networkName: NetworkName) => boolean;
+interface VerifyHardhatBaseConfig {
+    paths?: Partial<VerifyHardhatPathsConfig>;
+    networks?: Record<NetworkName, Partial<NetworkConfig>>;
     dryRun?: boolean;
 }
+interface VerifyHardhatTargetConfig extends VerifyHardhatBaseConfig {
+    filter?: VerifyHardhatFilterConfig;
+}
+interface VerifyHardhatContractConfig {
+    network: NetworkName;
+    address: string;
+    deployment: string;
+    contractName: string;
+    constructorArguments?: unknown[];
+}
+interface VerifyHardhatNonTargetConfig extends VerifyHardhatBaseConfig {
+    contracts: VerifyHardhatContractConfig[];
+}
+interface VerificationArtifact {
+    networkName: string;
+    networkConfig: NetworkConfig;
+    submitProps: SubmitForVerificationProps;
+}
+interface VerificationResult {
+    artifact: VerificationArtifact;
+    response?: VerificationResponse;
+    error?: unknown;
+}
 
-declare const _default: (config: VerifyHardhatDeploysConfig, logger: Logger) => Promise<void>;
+/**
+ * verifyNonTarget is useful when verifying a contract that does not have its own
+ * deployment file (i.e. is not a target of any hardhat deployment, hence the name).
+ *
+ * This happens when a contract is deployed dynamically from another contract,
+ * either using minimal proxy pattern or by new keyword
+ *
+ * In this case the construtor arguments must be provided manually for every contract/network combination
+ *
+ * @param config VerifyHardhatNonTargetConfig
+ * @param logger Logger
+ *
+ * @returns Promise<VerificationResult[]>
+ */
+declare const verifyNonTarget: (config: VerifyHardhatNonTargetConfig, logger: Logger) => Promise<VerificationResult[]>;
+declare const verifyTarget: (config: VerifyHardhatTargetConfig, logger: Logger) => Promise<VerificationResult[]>;
 
-export { _default as verifyHardhatDeploy };
+export { verifyNonTarget as verifyHardhatDeployNonTarget, verifyTarget as verifyHardhatDeployTarget };

package/dist/index.d.ts

@@ -1,24 +1,94 @@
 import { Logger } from 'winston';
 
-type NetworkName = string;
+declare enum LicenseType {
+    None = 1,
+    Unlicense = 2,
+    MIT = 3,
+    "GNU-GPLv2" = 4,
+    "GNU-GPLv3" = 5,
+    "GNU-LGPLv2.1" = 6,
+    "GNU-LGPLv3" = 7,
+    "BSD-2-Clause" = 8,
+    "BSD-3-Clause" = 9,
+    "MPL-2.0" = 10,
+    "OSL-3.0" = 11,
+    "Apache-2.0" = 12,
+    "GNU-AGPLv3" = 13,
+    "BUSL-1.1" = 14
+}
 
-interface VerifyHardhatDeployPathsConfig {
-    deployments: string;
+interface SubmitForVerificationProps {
+    apiKey?: string;
+    apiUrl: string;
+    address: string;
+    contractName: string;
+    compilerVersion: string;
+    optimizerRuns?: number;
+    licenseType?: LicenseType;
+    sourceCode: string;
+    constructorArguments?: string;
+    evmVersion?: string;
+}
+interface VerificationResponse {
+    alreadyVerified: boolean;
 }
-interface VerifyHardhatDeploysNetworkConfig {
+
+type NetworkName = string;
+interface NetworkConfig {
     apiUrl: string;
     apiKey?: string;
     browserUrl?: string;
 }
-type VerifyHardhatDeployFilterConfig = boolean | string | string[] | RegExp | VerifyHardhatDeployFilterConfigFunction;
-type VerifyHardhatDeployFilterConfigFunction = (name: string, path: string, networkName: NetworkName) => boolean;
-interface VerifyHardhatDeploysConfig {
-    paths?: Partial<VerifyHardhatDeployPathsConfig>;
-    networks?: Record<NetworkName, Partial<VerifyHardhatDeploysNetworkConfig>>;
-    verify?: VerifyHardhatDeployFilterConfig;
+
+interface VerifyHardhatPathsConfig {
+    deployments: string;
+}
+type VerifyHardhatFilterConfig = boolean | string | string[] | RegExp | VerifyHardhatFilterFunction;
+type VerifyHardhatFilterFunction = (name: string, path: string, networkName: NetworkName) => boolean;
+interface VerifyHardhatBaseConfig {
+    paths?: Partial<VerifyHardhatPathsConfig>;
+    networks?: Record<NetworkName, Partial<NetworkConfig>>;
     dryRun?: boolean;
 }
+interface VerifyHardhatTargetConfig extends VerifyHardhatBaseConfig {
+    filter?: VerifyHardhatFilterConfig;
+}
+interface VerifyHardhatContractConfig {
+    network: NetworkName;
+    address: string;
+    deployment: string;
+    contractName: string;
+    constructorArguments?: unknown[];
+}
+interface VerifyHardhatNonTargetConfig extends VerifyHardhatBaseConfig {
+    contracts: VerifyHardhatContractConfig[];
+}
+interface VerificationArtifact {
+    networkName: string;
+    networkConfig: NetworkConfig;
+    submitProps: SubmitForVerificationProps;
+}
+interface VerificationResult {
+    artifact: VerificationArtifact;
+    response?: VerificationResponse;
+    error?: unknown;
+}
 
-declare const _default: (config: VerifyHardhatDeploysConfig, logger: Logger) => Promise<void>;
+/**
+ * verifyNonTarget is useful when verifying a contract that does not have its own
+ * deployment file (i.e. is not a target of any hardhat deployment, hence the name).
+ *
+ * This happens when a contract is deployed dynamically from another contract,
+ * either using minimal proxy pattern or by new keyword
+ *
+ * In this case the construtor arguments must be provided manually for every contract/network combination
+ *
+ * @param config VerifyHardhatNonTargetConfig
+ * @param logger Logger
+ *
+ * @returns Promise<VerificationResult[]>
+ */
+declare const verifyNonTarget: (config: VerifyHardhatNonTargetConfig, logger: Logger) => Promise<VerificationResult[]>;
+declare const verifyTarget: (config: VerifyHardhatTargetConfig, logger: Logger) => Promise<VerificationResult[]>;
 
-export { _default as verifyHardhatDeploy };
+export { verifyNonTarget as verifyHardhatDeployNonTarget, verifyTarget as verifyHardhatDeployTarget };