🐛 Fix: Change contract import of generated file to import type {Contr…

…act} (#1382) ## Description closes #1343 ## Testing Explain the quality checks that have been done on the code changes ## Additional Information - [ ] I read the [contributing docs](../docs/contributing.md) (if this is your first contribution) Your ENS/address: --------- Co-authored-by: William Cory <[email protected]>
evmts · Aug 15, 2024 · 7eebe33 · 7eebe33
1 parent 35f2d5e
commit 7eebe33
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 8 deletions.
diff --git a/.changeset/eighty-carpets-listen.md b/.changeset/eighty-carpets-listen.md
@@ -0,0 +1,5 @@
+---
+"@tevm/runtime": patch
+---
+
+Changed the import type of Contract in generated files to include an explicit `type` modifier
diff --git a/bundler-packages/base-bundler/src/bundler.spec.ts b/bundler-packages/base-bundler/src/bundler.spec.ts
@@ -264,11 +264,13 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { Contract } from '@tevm/contract'
+				  "code": "import type { Contract } from '@tevm/contract'
 				const _abiTestContract = [] as const;
 				const _nameTestContract = "TestContract" as const;
 				/**
-				 * TestContract Contract
+				 * TestContract Contract (no bytecode)
+				 * change file name or add file that ends in '.s.sol' extension if you wish to compile the bytecode
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 				 */
 				export const TestContract: Contract<typeof _nameTestContract, typeof _abiTestContract, undefined, undefined, undefined, undefined>;",
 				  "modules": {
@@ -349,11 +351,13 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { Contract } from '@tevm/contract'
+				  "code": "import type { Contract } from '@tevm/contract'
 				const _abiTestContract = [] as const;
 				const _nameTestContract = "TestContract" as const;
 				/**
-				 * TestContract Contract
+				 * TestContract Contract (no bytecode)
+				 * change file name or add file that ends in '.s.sol' extension if you wish to compile the bytecode
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 				 */
 				export const TestContract: Contract<typeof _nameTestContract, typeof _abiTestContract, undefined, undefined, undefined, undefined>;",
 				  "modules": {
@@ -438,6 +442,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				} as const
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
@@ -521,6 +528,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				} as const
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
@@ -604,6 +614,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				}
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				module.exports.TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
@@ -687,6 +700,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				}
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				module.exports.TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
@@ -770,6 +786,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				}
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
@@ -853,6 +872,9 @@ describe(bundler.name, () => {
 				  "name": "TestContract",
 				  "humanReadableAbi": []
 				}
+				/**
+				 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
+				 */
 				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {

diff --git a/bundler-packages/runtime/src/generateRuntime.js b/bundler-packages/runtime/src/generateRuntime.js
@@ -7,13 +7,13 @@ import { generateTevmBody } from './generateTevmBody.js'
 const importsByModuleType = (contractPackage) => ({
 	contract: {
 		cjs: `const { createContract } = require('${contractPackage}')`,
-		dts: `import { Contract } from '${contractPackage}'`,
+		dts: `import type { Contract } from '${contractPackage}'`,
 		ts: `import { createContract } from '${contractPackage}'`,
 		mjs: `import { createContract } from '${contractPackage}'`,
 	},
 	script: {
 		cjs: `const { createContract } = require('${contractPackage}')`,
-		dts: `import { Contract } from '${contractPackage}'`,
+		dts: `import type { Contract } from '${contractPackage}'`,
 		ts: `import { createContract } from '${contractPackage}'`,
 		mjs: `import { createContract } from '${contractPackage}'`,
 	},

diff --git a/bundler-packages/runtime/src/generateRuntime.spec.ts b/bundler-packages/runtime/src/generateRuntime.spec.ts
@@ -63,7 +63,7 @@ describe('generateRuntime', () => {
 	it('should handle dts module type', () => {
 		const result = runSync(generateRuntime(artifacts, 'dts', false, '@tevm/contract'))
 		expect(result).toMatchInlineSnapshot(`
-			"import { Contract } from '@tevm/contract'
+			"import type { Contract } from '@tevm/contract'
 			const _abiMyContract = ["constructor() payable"] as const;
 			const _nameMyContract = "MyContract" as const;
 			/**

diff --git a/lsp/ts-plugin/src/decorators/getScriptSnapshot.spec.ts b/lsp/ts-plugin/src/decorators/getScriptSnapshot.spec.ts
@@ -126,7 +126,7 @@ describe(getScriptSnapshotDecorator.name, () => {
 		const fileName = path.join(__dirname, '../test/fixtures/HelloWorld2.sol')
 		const result = decorator.getScriptSnapshot(fileName)
 		expect((result as any).text).toMatchInlineSnapshot(`
-			"import { Contract } from 'tevm/contract'
+			"import type { Contract } from 'tevm/contract'
 			const _abiHelloWorld = ["function greet() pure returns (string)"] as const;
 			const _nameHelloWorld = "HelloWorld" as const;
 			/**