@rocketh/verifier 0.17.15 → 0.17.17

package/README.md

@@ -1 +1,7 @@
 # @rocketh/verifier
+
+Contract verification tool for rocketh, enabling you to submit verification proofs to verifier services like blockchain explorers (Etherscan) and Sourcify.
+
+For full documentation, visit [rocketh.dev](https://rocketh.dev).
+
+For hardhat-deploy documentation, see [rocketh.dev/hardhat-deploy/](https://rocketh.dev/hardhat-deploy/).

package/dist/cli.js

@@ -24,7 +24,6 @@ program
     .option('--fix-mispell', 'if set, will use correct spelling of form field')
     .action(async (options) => {
     const { environment, ...programOptions } = program.opts();
-    ;
     const resolvedConfig = await readAndResolveConfig({ ...programOptions });
     run(resolvedConfig, environment, {
         verifier: {
@@ -33,7 +32,7 @@ program
             endpoint: options.endpoint,
             forceLicense: options.forceLicense,
             license: options.license,
-            fixMispell: options.fixMispell
+            fixMispell: options.fixMispell,
         },
         minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
     });
@@ -45,14 +44,13 @@ program
     .option('--min-interval <value>', 'min interval between request in ms')
     .action(async (options) => {
     const { environment, ...programOptions } = program.opts();
-    ;
     const resolvedConfig = await readAndResolveConfig({ ...programOptions });
     run(resolvedConfig, environment, {
         verifier: {
             type: 'sourcify',
-            endpoint: options.endpoint
+            endpoint: options.endpoint,
         },
-        minInterval: options.minInterval ? parseInt(options.minInterval) : undefined
+        minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
     });
 });
 program
@@ -63,14 +61,13 @@ program
     // .option('--api <value>', 'api version (default to v2)')
     .action(async (options) => {
     const { environment, ...programOptions } = program.opts();
-    ;
     const resolvedConfig = await readAndResolveConfig({ ...programOptions });
     run(resolvedConfig, environment, {
         verifier: {
             type: 'blockscout',
-            endpoint: options.endpoint
+            endpoint: options.endpoint,
         },
-        minInterval: options.minInterval ? parseInt(options.minInterval) : undefined
+        minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
     });
 });
 program
@@ -79,7 +76,6 @@ program
     .option('--out <value>', 'folder to write metadata into')
     .action(async (options) => {
     const { environment, ...programOptions } = program.opts();
-    ;
     const resolvedConfig = await readAndResolveConfig({ ...programOptions });
     await exportMetadata(resolvedConfig, environment, { out: options.out || '_metadata' });
 });

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAS,MAAM,WAAW,CAAC;AAC1C,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACtD,OAAO,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,CAAC;AAEV,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACL,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,kCAAkC,CAAC;KAC/C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KAEpB,MAAM,CAAC,2BAA2B,EAAE,oCAAoC,CAAC;KACzE,cAAc,CAAC,2BAA2B,EAAE,4BAA4B,CAAC,CAAC;AAE5E,OAAO;KACL,OAAO,CAAC,WAAW,CAAC;KACpB,WAAW,CAAC,+CAA+C,CAAC;KAC5D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,mBAAmB,EAAE,qBAAqB,CAAC;KAClD,MAAM,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;KAClE,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;KACtE,MAAM,CAAC,eAAe,EAAE,iDAAiD,CAAC;KAC1E,MAAM,CAAC,KAAK,EAAE,OAAgH,EAAE,EAAE;IAClI,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAAA,CAAC;IACzD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE;QAChC,QAAQ,EAAE;YACT,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC9B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAA,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,OAAO;KACL,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,8CAA8C,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;KACtE,MAAM,CAAC,KAAK,EAAE,OAAkD,EAAE,EAAE;IACpE,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAAA,CAAC;IACzD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAG;QACjC,QAAQ,EAAE;YACT,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC1B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAA,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,OAAO;KACL,OAAO,CAAC,YAAY,CAAC;KACrB,WAAW,CAAC,gDAAgD,CAAC;KAC7D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;IACvE,0DAA0D;KACzD,MAAM,CAAC,KAAK,EAAE,OAAkD,EAAE,EAAE;IACpE,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAAA,CAAC;IACzD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE;QAChC,QAAQ,EAAE;YACT,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC1B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAA,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA,CAAC,CAAC,SAAS;KAC1E,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,OAAO;KACL,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,iBAAiB,CAAC;KAC9B,MAAM,CAAC,eAAe,EAAE,+BAA+B,CAAC;KACxD,MAAM,CAAC,KAAK,EAAE,OAAuB,EAAE,EAAE;IACzC,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAAA,CAAC;IACzD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,MAAM,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,WAAW,EAAC,CAAC,CAAC;AACtF,CAAC,CAAC,CAAC;AAEJ,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,GAAG,EAAC,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAC,OAAO,EAAS,MAAM,WAAW,CAAC;AAC1C,OAAO,GAAG,MAAM,iBAAiB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACtD,OAAO,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,CAAC;AAEV,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAC9B,OAAO;KACL,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,kCAAkC,CAAC;KAC/C,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;KAEpB,MAAM,CAAC,2BAA2B,EAAE,oCAAoC,CAAC;KACzE,cAAc,CAAC,2BAA2B,EAAE,4BAA4B,CAAC,CAAC;AAE5E,OAAO;KACL,OAAO,CAAC,WAAW,CAAC;KACpB,WAAW,CAAC,+CAA+C,CAAC;KAC5D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,mBAAmB,EAAE,qBAAqB,CAAC;KAClD,MAAM,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;KAClE,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;KACtE,MAAM,CAAC,eAAe,EAAE,iDAAiD,CAAC;KAC1E,MAAM,CACN,KAAK,EAAE,OAMN,EAAE,EAAE;IACJ,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACxD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE;QAChC,QAAQ,EAAE;YACT,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;YACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC9B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KAC5E,CAAC,CAAC;AACJ,CAAC,CACD,CAAC;AAEH,OAAO;KACL,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,8CAA8C,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;KACtE,MAAM,CAAC,KAAK,EAAE,OAAkD,EAAE,EAAE;IACpE,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACxD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE;QAChC,QAAQ,EAAE;YACT,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC1B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KAC5E,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,OAAO;KACL,OAAO,CAAC,YAAY,CAAC;KACrB,WAAW,CAAC,gDAAgD,CAAC;KAC7D,MAAM,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;KACtD,MAAM,CAAC,wBAAwB,EAAE,oCAAoC,CAAC;IACvE,0DAA0D;KACzD,MAAM,CAAC,KAAK,EAAE,OAAkD,EAAE,EAAE;IACpE,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACxD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,GAAG,CAAC,cAAc,EAAE,WAAW,EAAE;QAChC,QAAQ,EAAE;YACT,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC1B;QACD,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;KAC5E,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,OAAO;KACL,OAAO,CAAC,UAAU,CAAC;KACnB,WAAW,CAAC,iBAAiB,CAAC;KAC9B,MAAM,CAAC,eAAe,EAAE,+BAA+B,CAAC;KACxD,MAAM,CAAC,KAAK,EAAE,OAAuB,EAAE,EAAE;IACzC,MAAM,EAAC,WAAW,EAAE,GAAG,cAAc,EAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IACxD,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,EAAC,GAAG,cAAc,EAAC,CAAC,CAAC;IACvE,MAAM,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,WAAW,EAAC,CAAC,CAAC;AACtF,CAAC,CAAC,CAAC;AAEJ,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketh/verifier",
-  "version": "0.17.15",
+  "version": "0.17.17",
   "description": "submit verification proof to verifier services (blockchain explorer, sourcify...",
   "publishConfig": {
     "access": "public"
@@ -21,7 +21,8 @@
     "rocketh-verify": "dist/cli.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "dependencies": {
     "@types/fs-extra": "^11.0.4",
@@ -31,17 +32,17 @@
     "fs-extra": "^11.3.3",
     "ldenv": "^0.3.16",
     "neoqs": "^6.13.0",
-    "@rocketh/core": "0.17.7"
+    "@rocketh/core": "0.17.9"
   },
   "devDependencies": {
-    "@types/node": "^25.0.6",
-    "as-soon": "^0.0.11",
+    "@types/node": "^25.0.10",
+    "as-soon": "^0.1.4",
     "rimraf": "^6.1.2",
     "typescript": "^5.9.3",
-    "@rocketh/node": "0.17.15"
+    "@rocketh/node": "0.17.17"
   },
   "peerDependencies": {
-    "@rocketh/node": "0.17.15"
+    "@rocketh/node": "0.17.17"
   },
   "scripts": {
     "build": "tsc --project tsconfig.json",

package/src/blockscout.ts

@@ -0,0 +1,157 @@
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'path';
+import type {Abi, Deployment, UnknownDeployments} from '@rocketh/core/types';
+import {BlockscoutOptions} from './index.js';
+
+//https://eth.blockscout.com/api/v2/search?q=WETH
+const defaultEndpoints: {[chainId: string]: string} = {
+	'1': 'https://eth.blockscout.com/api/v2',
+	'11155111': 'https://eth-sepolia.blockscout.com/api/v2',
+	'5': 'https://eth-goerli.blockscout.com/api/v2',
+	'10': 'https://optimism.blockscout.com/api/v2',
+	'11155420': 'https://optimism-sepolia.blockscout.com/api/v2',
+	'61': 'https://etc.blockscout.com/api/v2',
+	'324': 'https://zksync.blockscout.com/api/v2',
+	'8453': 'https://base.blockscout.com/api/v2',
+	'84532': 'https://base-sepolia.blockscout.com/api/v2',
+	'100': 'https://gnosis.blockscout.com/api/v2',
+	'10200': 'https://gnosis-chiado.blockscout.com/api/v2',
+	'17001': 'https://17001-explorer-api.quarry.linfra.xyz/api/v2', // probably temporary
+};
+
+function sleep(ms: number) {
+	return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+function log(...args: any[]) {
+	console.log(...args);
+}
+
+function logError(...args: any[]) {
+	console.log(chalk.red(...args));
+}
+
+function logInfo(...args: any[]) {
+	console.log(chalk.yellow(...args));
+}
+
+function logSuccess(...args: any[]) {
+	console.log(chalk.green(...args));
+}
+
+function ensureTrailingSlash(s: string): string {
+	if (!s.endsWith('/')) {
+		s = s + '/';
+	}
+	return s;
+}
+
+export async function submitSourcesToBlockscout(
+	env: {
+		deployments: UnknownDeployments;
+		networkName: string;
+		chainId: string;
+		deploymentNames?: string[];
+		minInterval?: number;
+		logErrorOnFailure?: boolean;
+	},
+	config?: BlockscoutOptions,
+): Promise<void> {
+	config = config || {type: 'blockscout'};
+	const all = env.deployments;
+	const url = config.endpoint
+		? ensureTrailingSlash(config.endpoint)
+		: ensureTrailingSlash(defaultEndpoints[env.chainId]);
+
+	if (!url) {
+		logError(`no endpoint provided and no default known for chainId ${env.chainId}`);
+		return;
+	}
+
+	async function submit(name: string, deployment: Deployment<Abi>) {
+		const {address, metadata} = deployment;
+
+		try {
+			const checkResponse = await fetch(`${url}smart-contracts/${address.toLowerCase()}`);
+			const json = await checkResponse.json();
+			if (json.is_verified) {
+				log(`already verified: ${name} (${address}), skipping.`);
+				return;
+			}
+		} catch (e) {
+			logError(((e as any).response && JSON.stringify((e as any).response.data)) || e);
+		}
+
+		const metadataObj = JSON.parse(metadata);
+		const compilationTarget = metadataObj.settings?.compilationTarget;
+
+		let contractFilepath;
+		let contractName;
+		if (compilationTarget) {
+			contractFilepath = Object.keys(compilationTarget)[0];
+			contractName = compilationTarget[contractFilepath];
+		}
+
+		if (!contractFilepath || !contractName) {
+			return logError(
+				`Failed to extract contract fully qualified name from metadata.settings.compilationTarget for ${name}. Skipping.`,
+			);
+		}
+
+		const contractNamePath = `${contractFilepath}:${contractName}`;
+
+		const formData = new FormData();
+		formData.append('address_hash', address);
+		formData.append('compiler_version', JSON.parse(metadata).compiler.version);
+		formData.append('constructor_args', deployment.argsData);
+		formData.append('autodetect_constructor_args', 'false');
+		formData.append('contract_name', contractNamePath);
+
+		const metadataBlob = new Blob([metadata], {
+			type: 'application/json',
+		});
+		formData.append('files[0]', metadataBlob, 'metadata.json');
+
+		try {
+			const submissionResponse = await fetch(
+				`${url}smart-contracts/${address.toLowerCase()}/verification/via/standard-input`,
+				{body: formData, method: 'POST'},
+			);
+			const json = await submissionResponse.json();
+			if (json.message === 'Smart-contract verification started') {
+				logSuccess(` => contract ${name} verification has started`);
+			} else {
+				logError(` => contract ${name} might not have gone throyugh`, json);
+			}
+		} catch (e) {
+			if (env?.logErrorOnFailure) {
+				const failingMetadataFolder = path.join('failing_metadata', env.chainId);
+				fs.ensureDirSync(failingMetadataFolder);
+				fs.writeFileSync(path.join(failingMetadataFolder, `${name}_at_${address}.json`), metadata);
+			}
+			logError(((e as any).response && JSON.stringify((e as any).response.data)) || e);
+		}
+	}
+
+	for (const name of env.deploymentNames ? env.deploymentNames : Object.keys(all)) {
+		const deployment = all[name];
+
+		if (!deployment.metadata) {
+			logError(`Contract ${name} was deployed without saving metadata. Cannot submit to sourcify, skipping.`);
+			return;
+		}
+
+		logInfo(`verifying ${name} (${deployment.address} on chain ${env.chainId}) ...`);
+
+		// if (config?.version === 'v1') {
+		// 	await submitV1(name, deployment);
+		// } else {
+		await submit(name, deployment);
+		// }
+
+		if (env.minInterval) {
+			await sleep(env.minInterval);
+		}
+	}
+}

package/src/cli.ts

@@ -0,0 +1,98 @@
+#! /usr/bin/env node
+import {loadEnv} from 'ldenv';
+import {run} from './index.js';
+import {Command, Option} from 'commander';
+import pkg from '../package.json' with {type: 'json'};
+import {exportMetadata} from './metadata.js';
+import {readAndResolveConfig} from '@rocketh/node';
+loadEnv();
+
+const commandName = `rocketh-verify`;
+
+const program = new Command();
+program
+	.name(commandName)
+	.description('submit contract for verification')
+	.version(pkg.version)
+
+	.option('-d, --deployments <value>', 'folder where deployments are saved')
+	.requiredOption('-e, --environment <value>', 'environment context to use');
+
+program
+	.command('etherscan')
+	.description('submit contract for verification to etherscan')
+	.option('--endpoint <value>', 'endpoint to connect to')
+	.option('--license <value>', 'source code license')
+	.option('--force-license', 'force the use of the license provided')
+	.option('--min-interval <value>', 'min interval between request in ms')
+	.option('--fix-mispell', 'if set, will use correct spelling of form field')
+	.action(
+		async (options: {
+			endpoint?: string;
+			forceLicense: boolean;
+			license: string;
+			minInterval?: string;
+			fixMispell?: boolean;
+		}) => {
+			const {environment, ...programOptions} = program.opts();
+			const resolvedConfig = await readAndResolveConfig({...programOptions});
+			run(resolvedConfig, environment, {
+				verifier: {
+					type: 'etherscan',
+					apiKey: process.env['ETHERSCAN_API_KEY'],
+					endpoint: options.endpoint,
+					forceLicense: options.forceLicense,
+					license: options.license,
+					fixMispell: options.fixMispell,
+				},
+				minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
+			});
+		},
+	);
+
+program
+	.command('sourcify')
+	.description('submit contract for verification to sourcify')
+	.option('--endpoint <value>', 'endpoint to connect to')
+	.option('--min-interval <value>', 'min interval between request in ms')
+	.action(async (options: {endpoint?: string; minInterval?: string}) => {
+		const {environment, ...programOptions} = program.opts();
+		const resolvedConfig = await readAndResolveConfig({...programOptions});
+		run(resolvedConfig, environment, {
+			verifier: {
+				type: 'sourcify',
+				endpoint: options.endpoint,
+			},
+			minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
+		});
+	});
+
+program
+	.command('blockscout')
+	.description('submit contract for verification to blockscout')
+	.option('--endpoint <value>', 'endpoint to connect to')
+	.option('--min-interval <value>', 'min interval between request in ms')
+	// .option('--api <value>', 'api version (default to v2)')
+	.action(async (options: {endpoint?: string; minInterval?: string}) => {
+		const {environment, ...programOptions} = program.opts();
+		const resolvedConfig = await readAndResolveConfig({...programOptions});
+		run(resolvedConfig, environment, {
+			verifier: {
+				type: 'blockscout',
+				endpoint: options.endpoint,
+			},
+			minInterval: options.minInterval ? parseInt(options.minInterval) : undefined,
+		});
+	});
+
+program
+	.command('metadata')
+	.description('export metadata')
+	.option('--out <value>', 'folder to write metadata into')
+	.action(async (options: {out?: string}) => {
+		const {environment, ...programOptions} = program.opts();
+		const resolvedConfig = await readAndResolveConfig({...programOptions});
+		await exportMetadata(resolvedConfig, environment, {out: options.out || '_metadata'});
+	});
+
+program.parse(process.argv);

package/src/etherscan.ts

@@ -0,0 +1,420 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import fs from 'fs';
+import * as qs from 'neoqs';
+import chalk from 'chalk';
+import {matchAll} from './utils/match-all.js';
+import {UnknownDeployments} from '@rocketh/core/types';
+import {EtherscanOptions} from './index.js';
+
+const defaultEndpoint = `https://api.etherscan.io/v2/api`;
+function log(...args: any[]) {
+	console.log(...args);
+}
+
+function logError(...args: any[]) {
+	console.log(chalk.red(...args));
+}
+
+function logInfo(...args: any[]) {
+	console.log(chalk.yellow(...args));
+}
+
+function logSuccess(...args: any[]) {
+	console.log(chalk.green(...args));
+}
+
+function sleep(ms: number) {
+	return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+function writeRequestIfRequested(
+	write: boolean,
+	networkName: string,
+	name: string,
+	request: string,
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	postData: any,
+) {
+	if (write) {
+		try {
+			fs.mkdirSync('etherscan_requests');
+		} catch (e) {}
+		const folder = `etherscan_requests/${networkName}`;
+		try {
+			fs.mkdirSync(folder);
+		} catch (e) {}
+		fs.writeFileSync(`${folder}/${name}.formdata`, request);
+		fs.writeFileSync(`${folder}/${name}.json`, JSON.stringify(postData));
+		fs.writeFileSync(`${folder}/${name}_multi-source.json`, postData.sourceCode);
+	}
+}
+
+function extractOneLicenseFromSourceFile(source: string): string | undefined {
+	const licenses = extractLicenseFromSources(source);
+	if (licenses.length === 0) {
+		return undefined;
+	}
+	return licenses[0]; // TODO error out on multiple SPDX ?
+}
+
+function extractLicenseFromSources(metadata: string): string[] {
+	const regex = /\/\/\s*\t*SPDX-License-Identifier:\s*\t*(.*?)[\s\\]/g;
+	const matches = matchAll(metadata, regex).toArray();
+	const licensesFound: {[license: string]: boolean} = {};
+	const licenses = [];
+	if (matches) {
+		for (const match of matches) {
+			if (!licensesFound[match]) {
+				licensesFound[match] = true;
+				licenses.push(match);
+			}
+		}
+	}
+	return licenses;
+}
+
+function getLicenseType(license: string): undefined | number {
+	const licenseType = (() => {
+		if (license === 'None') {
+			return 1;
+		}
+		if (license === 'UNLICENSED') {
+			return 2;
+		}
+		if (license === 'MIT') {
+			return 3;
+		}
+		if (license === 'GPL-2.0') {
+			return 4;
+		}
+		if (license === 'GPL-3.0') {
+			return 5;
+		}
+		if (license === 'LGPL-2.1') {
+			return 6;
+		}
+		if (license === 'LGPL-3.0') {
+			return 7;
+		}
+		if (license === 'BSD-2-Clause') {
+			return 8;
+		}
+		if (license === 'BSD-3-Clause') {
+			return 9;
+		}
+		if (license === 'MPL-2.0') {
+			return 10;
+		}
+		if (license === 'OSL-3.0') {
+			return 11;
+		}
+		if (license === 'Apache-2.0') {
+			return 12;
+		}
+		if (license === 'AGPL-3.0') {
+			return 13;
+		}
+		if (license === 'BUSL-1.1') {
+			return 14;
+		}
+	})();
+	return licenseType;
+}
+
+export async function submitSourcesToEtherscan(
+	env: {
+		deployments: UnknownDeployments;
+		networkName: string;
+		chainId: string;
+		deploymentNames?: string[];
+		minInterval?: number;
+		logErrorOnFailure?: boolean;
+	},
+	config?: EtherscanOptions,
+): Promise<void> {
+	config = config || {type: 'etherscan'};
+	const licenseOption = config.license;
+	const forceLicense = config.forceLicense;
+	const etherscanApiKey = config.apiKey;
+	const all = env.deployments;
+	const networkName = env.networkName;
+	let endpoint = config.endpoint;
+	if (!endpoint) {
+		endpoint = defaultEndpoint;
+	}
+
+	async function submit(name: string) {
+		const deployment = all[name];
+		const {address, metadata: metadataString} = deployment;
+		const abiResponse = await fetch(
+			`${endpoint}?chainid=${env.chainId}&module=contract&action=getabi&address=${address}&apikey=${etherscanApiKey}`,
+		);
+		const json = await abiResponse.json();
+		let contractABI;
+		if (json.status !== '0') {
+			try {
+				contractABI = JSON.parse(json.result);
+			} catch (e) {
+				logError(`faled to get abi`, JSON.stringify(json), e);
+				return;
+			}
+		}
+		if (contractABI && contractABI !== '') {
+			log(`already verified: ${name} (${address}), skipping.`);
+			return;
+		}
+
+		if (!metadataString) {
+			logError(`Contract ${name} was deployed without saving metadata. Cannot submit to etherscan, skipping.`);
+			return;
+		}
+		const metadata = JSON.parse(metadataString);
+		const compilationTarget = metadata.settings?.compilationTarget;
+
+		let contractFilepath;
+		let contractName;
+		if (compilationTarget) {
+			contractFilepath = Object.keys(compilationTarget)[0];
+			contractName = compilationTarget[contractFilepath];
+		}
+
+		if (!contractFilepath || !contractName) {
+			return logError(
+				`Failed to extract contract fully qualified name from metadata.settings.compilationTarget for ${name}. Skipping.`,
+			);
+		}
+
+		const contractNamePath = `${contractFilepath}:${contractName}`;
+
+		const contractSourceFile = metadata.sources[contractFilepath].content;
+		const sourceLicenseType = extractOneLicenseFromSourceFile(contractSourceFile);
+
+		let license = licenseOption;
+		if (!sourceLicenseType) {
+			if (!license) {
+				return logError(
+					`no license speccified in the source code for ${name} (${contractNamePath}), Please use option --license <SPDX>`,
+				);
+			}
+		} else {
+			if (license && license !== sourceLicenseType) {
+				if (!forceLicense) {
+					return logError(
+						`mismatch for --license option (${licenseOption}) and the one specified in the source code for ${name}.\nLicenses found in source : ${sourceLicenseType}\nYou can use option --force-license to force option --license`,
+					);
+				}
+			} else {
+				license = sourceLicenseType;
+				if (!getLicenseType(license)) {
+					return logError(
+						`license :"${license}" found in source code for ${name} (${contractNamePath}) but this license is not supported by etherscan, list of supported license can be found here : https://etherscan.io/contract-license-types . This tool expect the SPDX id, except for "None" and "UNLICENSED"`,
+					);
+				}
+			}
+		}
+
+		const licenseType = getLicenseType(license);
+
+		if (!licenseType) {
+			return logError(
+				`license :"${license}" not supported by etherscan, list of supported license can be found here : https://etherscan.io/contract-license-types . This tool expect the SPDX id, except for "None" and "UNLICENSED"`,
+			);
+		}
+
+		let solcInput: {
+			language: string;
+			settings: any;
+			sources: Record<string, {content: string}>;
+		};
+
+		const settings = {...metadata.settings};
+		delete settings.compilationTarget;
+		solcInput = {
+			language: metadata.language,
+			settings,
+			sources: {},
+		};
+		for (const sourcePath of Object.keys(metadata.sources)) {
+			const source = metadata.sources[sourcePath];
+			// only content as this fails otherwise
+			solcInput.sources[sourcePath] = {
+				content: source.content,
+			};
+		}
+
+		// Adding Libraries ....
+		if (deployment.libraries) {
+			const settings = solcInput.settings;
+			settings.libraries = settings.libraries || {};
+			for (const libraryName of Object.keys(deployment.libraries)) {
+				if (!settings.libraries[contractNamePath]) {
+					settings.libraries[contractNamePath] = {};
+				}
+				settings.libraries[contractNamePath][libraryName] = deployment.libraries[libraryName];
+			}
+		}
+		const solcInputString = JSON.stringify(solcInput);
+
+		if (env.minInterval) {
+			await sleep(env.minInterval);
+		}
+		logInfo(`verifying ${name} (${address}) ...`);
+
+		let constructorArguments: string | undefined;
+		if (deployment.argsData) {
+			constructorArguments = deployment.argsData.slice(2);
+		} else {
+			// TODO ?
+			// logInfo(`no argsData found, falling back on args (hardhat-deploy v1)`);
+			// if ((deployment as any).args) {
+			// 	const constructorABI: {inputs: any[]} = deployment.abi.find(
+			// 	  (v) => v.type === 'constructor'
+			// 	);
+			// 	if (constructorABI) {
+			// 	  constructorArguements = encode
+			// 		.encode(constructor.inputs, deployment.args)
+			// 		.slice(2);
+			// 	}
+			//   } else {
+			// 	logInfo(`no args found, assuming empty constructor...`);
+			//   }
+			logInfo(`no args found, assuming empty constructor...`);
+		}
+
+		const postData: {
+			[fieldName: string]: string | number | void | undefined; // TODO type
+		} = {
+			apikey: etherscanApiKey,
+			module: 'contract',
+			action: 'verifysourcecode',
+			contractaddress: address,
+			sourceCode: solcInputString,
+			codeformat: 'solidity-standard-json-input',
+			contractname: contractNamePath,
+			compilerversion: `v${metadata.compiler.version}`, // see http://etherscan.io/solcversions for list of support versions
+			constructorArguements: constructorArguments, // note the spelling mistake by etherscan
+			licenseType,
+		};
+
+		if (config?.fixMispell) {
+			postData.constructorArguments = postData.constructorArguements;
+			delete postData.constructorArguements;
+		}
+
+		const formDataAsString = qs.stringify(postData);
+		const data = new URLSearchParams();
+		for (const entry of Object.entries(postData)) {
+			if (entry[1]) {
+				if (typeof entry[1] === 'number') {
+					data.append(entry[0], entry[1].toString());
+				} else {
+					data.append(entry[0], entry[1]);
+				}
+			}
+		}
+		const submissionResponse = await fetch(`${endpoint}?chainid=${env.chainId}`, {
+			method: 'POST',
+			headers: {'content-type': 'application/x-www-form-urlencoded'},
+			body: data,
+		});
+
+		let submissionJson;
+		let guid: string | undefined;
+		const text = await submissionResponse.clone().text();
+		try {
+			submissionJson = await submissionResponse.json();
+
+			if (submissionJson?.status === '1') {
+				guid = submissionJson.result;
+			} else {
+				logError(
+					`contract ${name} failed to submit : "${submissionJson.message}" : "${submissionJson.result}"`,
+					JSON.stringify(submissionJson),
+				);
+				writeRequestIfRequested(env?.logErrorOnFailure || false, networkName, name, formDataAsString, postData);
+				return;
+			}
+		} catch (err) {
+			logError(`failed to parse response`, text, err);
+			writeRequestIfRequested(env?.logErrorOnFailure || false, networkName, name, formDataAsString, postData);
+			return;
+		}
+
+		if (!guid) {
+			logError(`contract submission for ${name} failed to return a guid`);
+			writeRequestIfRequested(env?.logErrorOnFailure || false, networkName, name, formDataAsString, postData);
+			return;
+		}
+
+		async function checkStatus(): Promise<string | undefined> {
+			if (env.minInterval) {
+				await sleep(env.minInterval);
+			}
+			// TODO while loop and delay :
+			const statusResponse = await fetch(
+				`${endpoint}?chainid=${env.chainId}&apikey=${etherscanApiKey}&guid=${guid}&module=contract&action=checkverifystatus`,
+			);
+			const json = await statusResponse.json();
+
+			// blockscout seems to return status == 1 in case of failure
+			// so we check string first
+			if (json.result === 'Pending in queue') {
+				return undefined;
+			}
+			if (json.result !== 'Fail - Unable to verify') {
+				if (json.status === '1') {
+					// console.log(statusData);
+					return 'success';
+				}
+			}
+			logError(`Failed to verify contract ${name}: ${json.message}, ${json.result}`);
+
+			logError(
+				JSON.stringify(
+					{
+						apikey: 'XXXXXX',
+						module: 'contract',
+						action: 'verifysourcecode',
+						contractaddress: address,
+						sourceCode: '...',
+						codeformat: 'solidity-standard-json-input',
+						contractname: contractNamePath,
+						compilerversion: `v${metadata.compiler.version}`, // see http://etherscan.io/solcversions for list of support versions
+						constructorArguements: constructorArguments, // note the spelling mistake by etherscan
+						licenseType,
+					},
+					null,
+					'  ',
+				),
+			);
+			// logError(JSON.stringify(postData, null, "  "));
+			// logInfo(postData.sourceCode);
+			return 'failure';
+		}
+
+		logInfo('waiting for result...');
+		let result;
+		while (!result) {
+			await new Promise((resolve) => setTimeout(resolve, 10 * 1000));
+			result = await checkStatus();
+		}
+
+		if (result === 'success') {
+			logSuccess(` => contract ${name} is now verified`);
+		}
+
+		if (result === 'failure') {
+			writeRequestIfRequested(env?.logErrorOnFailure || false, networkName, name, formDataAsString, postData);
+			logInfo('Etherscan failed to verify the source provided');
+		} else {
+			writeRequestIfRequested(env?.logErrorOnFailure || false, networkName, name, formDataAsString, postData);
+		}
+	}
+
+	for (const name of env.deploymentNames ? env.deploymentNames : Object.keys(all)) {
+		await submit(name);
+		if (env.minInterval) {
+			await sleep(env.minInterval);
+		}
+	}
+}

package/src/index.ts

@@ -0,0 +1,84 @@
+import {loadDeploymentsFromFiles} from '@rocketh/node';
+import type {ResolvedUserConfig} from '@rocketh/core/types';
+import {submitSourcesToEtherscan} from './etherscan.js';
+import {submitSourcesToSourcify} from './sourcify.js';
+import {submitSourcesToBlockscout} from './blockscout.js';
+
+export type EtherscanOptions = {
+	type: 'etherscan';
+	endpoint?: string;
+	apiKey?: string;
+	license?: string;
+	forceLicense?: boolean;
+	fixMispell?: boolean;
+};
+
+export type SourcifyOptions = {
+	type: 'sourcify';
+	endpoint?: string;
+};
+
+export type BlockscoutOptions = {
+	type: 'blockscout';
+	endpoint?: string;
+	// version?: string;
+};
+
+export type VerificationOptions = {
+	verifier: EtherscanOptions | SourcifyOptions | BlockscoutOptions;
+	deploymentNames?: string[];
+	minInterval?: number;
+	logErrorOnFailure?: boolean;
+};
+
+export async function run(config: ResolvedUserConfig, environmentName: string, options: VerificationOptions) {
+	const {deployments, chainId} = await loadDeploymentsFromFiles(config.deployments, environmentName, false);
+
+	if (Object.keys(deployments).length === 0) {
+		console.log(`the environment ${environmentName} has zero deployments`);
+		process.exit();
+	}
+
+	if (!chainId) {
+		console.error(`the environment ${environmentName} has no chainId recorded`);
+		process.exit(1);
+	}
+
+	if (options.verifier.type === 'etherscan') {
+		await submitSourcesToEtherscan(
+			{
+				chainId,
+				deployments,
+				networkName: environmentName, // TODO ? should this not be the actual network name
+				deploymentNames: options.deploymentNames,
+				minInterval: options.minInterval,
+				logErrorOnFailure: options.logErrorOnFailure,
+			},
+			options.verifier,
+		);
+	} else if (options.verifier.type === 'sourcify') {
+		await submitSourcesToSourcify(
+			{
+				chainId,
+				deployments,
+				networkName: environmentName, // TODO ? should this not be the actual network name
+				deploymentNames: options.deploymentNames,
+				minInterval: options.minInterval,
+				logErrorOnFailure: options.logErrorOnFailure,
+			},
+			options.verifier,
+		);
+	} else if (options.verifier.type === 'blockscout') {
+		await submitSourcesToBlockscout(
+			{
+				chainId,
+				deployments,
+				networkName: environmentName, // TODO ? should this not be the actual network name
+				deploymentNames: options.deploymentNames,
+				minInterval: options.minInterval,
+				logErrorOnFailure: options.logErrorOnFailure,
+			},
+			options.verifier,
+		);
+	}
+}

package/src/metadata.ts

@@ -0,0 +1,31 @@
+import {loadDeploymentsFromFiles} from '@rocketh/node';
+import type {ResolvedUserConfig} from '@rocketh/core/types';
+import fs from 'fs-extra';
+import path from 'path';
+
+export async function exportMetadata(config: ResolvedUserConfig, environmentName: string, {out}: {out: string}) {
+	const {deployments, chainId} = await loadDeploymentsFromFiles(config.deployments, environmentName, false);
+
+	if (Object.keys(deployments).length === 0) {
+		console.log(`the environment ${environmentName} has zero deployments`);
+		process.exit();
+	}
+
+	if (!chainId) {
+		console.error(`the environment ${environmentName} has no chainId recorded`);
+		process.exit(1);
+	}
+
+	const folder = path.join(out, environmentName);
+	fs.emptyDirSync(folder);
+	const deploymentNames = Object.keys(deployments);
+	for (const deploymentName of deploymentNames) {
+		const deployment = deployments[deploymentName];
+		if (deployment.metadata) {
+			fs.writeFileSync(
+				path.join(folder, `${deploymentName}_at_${deployment.address}.metadata.json`),
+				deployment.metadata,
+			);
+		}
+	}
+}

package/src/sourcify.ts

@@ -0,0 +1,109 @@
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'path';
+import {UnknownDeployments} from '@rocketh/core/types';
+import {SourcifyOptions} from './index.js';
+
+function sleep(ms: number) {
+	return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+function log(...args: any[]) {
+	console.log(...args);
+}
+
+function logError(...args: any[]) {
+	console.log(chalk.red(...args));
+}
+
+function logInfo(...args: any[]) {
+	console.log(chalk.yellow(...args));
+}
+
+function logSuccess(...args: any[]) {
+	console.log(chalk.green(...args));
+}
+
+function ensureTrailingSlash(s: string): string {
+	const lastChar = s.substr(-1);
+	if (lastChar != '/') {
+		s = s + '/';
+	}
+	return s;
+}
+
+// const defaultEndpoint = 'https://server.verificationstaging.shardlabs.io/';
+const defaultEndpoint = 'https://sourcify.dev/server/';
+
+export async function submitSourcesToSourcify(
+	env: {
+		deployments: UnknownDeployments;
+		networkName: string;
+		chainId: string;
+		deploymentNames?: string[];
+		minInterval?: number;
+		logErrorOnFailure?: boolean;
+	},
+	config?: SourcifyOptions,
+): Promise<void> {
+	config = config || {type: 'sourcify'};
+	const all = env.deployments;
+	const url = config.endpoint ? ensureTrailingSlash(config.endpoint) : defaultEndpoint;
+
+	async function submit(name: string) {
+		const deployment = all[name];
+		const {address, metadata: metadataString} = deployment;
+
+		try {
+			const checkResponse = await fetch(
+				`${url}checkByAddresses?addresses=${address.toLowerCase()}&chainIds=${env.chainId}`,
+			);
+			const json = await checkResponse.json();
+			if (json[0].status === 'perfect') {
+				log(`already verified: ${name} (${address}), skipping.`);
+				return;
+			}
+		} catch (e) {
+			logError(((e as any).response && JSON.stringify((e as any).response.data)) || e);
+		}
+
+		if (!metadataString) {
+			logError(`Contract ${name} was deployed without saving metadata. Cannot submit to sourcify, skipping.`);
+			return;
+		}
+
+		logInfo(`verifying ${name} (${address} on chain ${env.chainId}) ...`);
+
+		const formData = new FormData();
+		formData.append('address', address);
+		formData.append('chain', env.chainId);
+		const metadataBlob = new Blob([metadataString], {
+			type: 'application/json',
+		});
+		formData.append('files', metadataBlob, 'metadata.json');
+
+		try {
+			const submissionResponse = await fetch(url, {body: formData, method: 'POST'});
+			const json = await submissionResponse.json();
+			if (json.result[0].status === 'perfect') {
+				logSuccess(` => contract ${name} is now verified`);
+			} else {
+				logError(` => contract ${name} is not verified`);
+			}
+		} catch (e) {
+			if (env?.logErrorOnFailure) {
+				const failingMetadataFolder = path.join('failing_metadata', env.chainId);
+				fs.ensureDirSync(failingMetadataFolder);
+				fs.writeFileSync(path.join(failingMetadataFolder, `${name}_at_${address}.json`), metadataString);
+			}
+			logError(((e as any).response && JSON.stringify((e as any).response.data)) || e);
+		}
+	}
+
+	for (const name of env.deploymentNames ? env.deploymentNames : Object.keys(all)) {
+		await submit(name);
+		if (env.minInterval) {
+			await sleep(env.minInterval);
+		}
+	}
+}

package/src/utils/match-all.ts

@@ -0,0 +1,72 @@
+// taken  from package match-all
+export function matchAll(s: string, r: RegExp) {
+	return {
+		input: s,
+		regex: r,
+
+		/**
+		 * next
+		 * Get the next match in single group match.
+		 *
+		 * @name next
+		 * @function
+		 * @return {String|null} The matched snippet.
+		 */
+		next() {
+			let c = this.nextRaw();
+			if (c) {
+				for (let i = 1; i < c.length; i++) {
+					if (c[i]) {
+						return c[i];
+					}
+				}
+			}
+			return null;
+		},
+
+		/**
+		 * nextRaw
+		 * Get the next match in raw regex output. Usefull to get another group match.
+		 *
+		 * @name nextRaw
+		 * @function
+		 * @returns {Array|null} The matched snippet
+		 */
+		nextRaw() {
+			let c = this.regex.exec(this.input);
+			return c;
+		},
+
+		/**
+		 * toArray
+		 * Get all the matches.
+		 *
+		 * @name toArray
+		 * @function
+		 * @return {Array} The matched snippets.
+		 */
+		toArray() {
+			let res = [],
+				c = null;
+
+			while ((c = this.next())) {
+				res.push(c);
+			}
+
+			return res;
+		},
+
+		/**
+		 * reset
+		 * Reset the index.
+		 *
+		 * @name reset
+		 * @function
+		 * @param {Number} i The new index (default: `0`).
+		 * @return {Number} The new index.
+		 */
+		reset(i: number = 0) {
+			return (this.regex.lastIndex = i);
+		},
+	};
+}