📝 Feat: Add natspec comments to contract imports

.changeset/tidy-pans-melt.md

@@ -0,0 +1,5 @@
+---
+"@tevm/runtime": patch
+---
+
+Added natspec comments to contract imports linking to documentation

bundler-packages/runtime/src/generateRuntime.spec.ts

@@ -54,6 +54,7 @@ describe('generateRuntime', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			module.exports.MyContract = createContract(_MyContract)"
 		`)
@@ -66,7 +67,9 @@ describe('generateRuntime', () => {
 			const _abiMyContract = ["constructor() payable"] as const;
 			const _nameMyContract = "MyContract" as const;
 			/**
-			 * MyContract Contract
+			 * MyContract 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
 			 * @notice MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
@@ -87,6 +90,7 @@ describe('generateRuntime', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const MyContract = createContract(_MyContract)"
 		`)
@@ -105,6 +109,7 @@ describe('generateRuntime', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const MyContract = createContract(_MyContract)"
 		`)

bundler-packages/runtime/src/generateTevmBody.js

@@ -35,10 +35,10 @@ export const generateTevmBody = (artifacts, moduleType, includeBytecode) => {
 				if (userdoc.notice) {
 					natspec.unshift(` * ${userdoc.notice}`)
 				}
-				if (natspec.length) {
-					natspec.unshift('/**')
-					natspec.push(' */')
-				}
+				natspec.push(` * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation`)
+				natspec.unshift('/**')
+				natspec.push(' */')
+
 				if (moduleType === 'cjs') {
 					return [
 						`const _${contractName} = ${contract}`,

bundler-packages/runtime/src/generateTevmBody.spec.ts

@@ -45,6 +45,7 @@ describe('generateTevmBody', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			module.exports.MyContract = createContract(_MyContract)
 			const _AnotherContract = {
@@ -53,6 +54,7 @@ describe('generateTevmBody', () => {
 			}
 			/**
 			 * MyContract
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			module.exports.AnotherContract = createContract(_AnotherContract)"
 		`)
@@ -68,6 +70,7 @@ describe('generateTevmBody', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const MyContract = createContract(_MyContract)
 			const _AnotherContract = {
@@ -76,6 +79,7 @@ describe('generateTevmBody', () => {
 			}
 			/**
 			 * MyContract
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const AnotherContract = createContract(_AnotherContract)"
 		`)
@@ -91,6 +95,7 @@ describe('generateTevmBody', () => {
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const MyContract = createContract(_MyContract)
 			const _AnotherContract = {
@@ -99,6 +104,7 @@ describe('generateTevmBody', () => {
 			} as const
 			/**
 			 * MyContract
+			 * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation
 			 */
 			export const AnotherContract = createContract(_AnotherContract)"
 		`)
@@ -110,15 +116,19 @@ describe('generateTevmBody', () => {
 			"const _abiMyContract = [] as const;
 			const _nameMyContract = "MyContract" as const;
 			/**
-			 * MyContract Contract
+			 * MyContract 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
 			 * @notice MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
 			export const MyContract: Contract<typeof _nameMyContract, typeof _abiMyContract, undefined, undefined, undefined, undefined>;
 			const _abiAnotherContract = [] as const;
 			const _nameAnotherContract = "AnotherContract" as const;
 			/**
-			 * AnotherContract Contract
+			 * AnotherContract 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
 			 * @notice MyContract
 			 */
 			export const AnotherContract: Contract<typeof _nameAnotherContract, typeof _abiAnotherContract, undefined, undefined, undefined, undefined>;"

bundler-packages/runtime/src/generateTevmBodyDts.js

@@ -24,13 +24,10 @@ export const generateDtsBody = (artifacts, includeBytecode) => {
 					return [
 						`const _name${contractName} = ${JSON.stringify(contractName, null, 2)} as const;`,
 						`const _abi${contractName} = ${JSON.stringify(contract.humanReadableAbi, null, 2)} as const;`,
-						'// type _Address = undefined',
-						'// type _Bytecode = `0x${string}`',
-						'// type _DeployedBytecode = `0x${string}`',
-						'// type _Code = undefined',
 						'/**',
-						` * ${contractName} Contract+Script`,
+						` * ${contractName} Contract (with bytecode)`,
 						...natspec,
+						` * @see [contract docs](https://tevm.sh/learn/contracts/) for more documentation`,
 						' */',
 						`export const ${contractName}: Contract<`,
 						`  typeof _name${contractName},`,
@@ -46,7 +43,9 @@ export const generateDtsBody = (artifacts, includeBytecode) => {
 					`const _abi${contractName} = ${JSON.stringify(contract.humanReadableAbi)} as const;`,
 					`const _name${contractName} = ${JSON.stringify(contractName)} as const;`,
 					'/**',
-					` * ${contractName} Contract`,
+					` * ${contractName} 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`,
 					...natspec,
 					' */',
 					`export const ${contractName}: Contract<typeof _name${contractName}, typeof _abi${contractName}, undefined, undefined, undefined, undefined>;`,

bundler-packages/runtime/src/generateTevmBodyDts.spec.ts

@@ -54,22 +54,28 @@ describe('generateDtsBody', () => {
 			"const _abiMyContract = ["constructor() payable"] as const;
 			const _nameMyContract = "MyContract" as const;
 			/**
-			 * MyContract Contract
+			 * MyContract 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
 			 * @notice MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
 			export const MyContract: Contract<typeof _nameMyContract, typeof _abiMyContract, undefined, undefined, undefined, undefined>;
 			const _abiAnotherContract = [] as const;
 			const _nameAnotherContract = "AnotherContract" as const;
 			/**
-			 * AnotherContract Contract
+			 * AnotherContract 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
 			 * @notice MyContract
 			 */
 			export const AnotherContract: Contract<typeof _nameAnotherContract, typeof _abiAnotherContract, undefined, undefined, undefined, undefined>;
 			const _abiMissingContract = [] as const;
 			const _nameMissingContract = "MissingContract" as const;
 			/**
-			 * MissingContract Contract
+			 * MissingContract 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
 			 * @notice MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */

lsp/ts-plugin/src/decorators/getScriptSnapshot.spec.ts

@@ -130,13 +130,17 @@ describe(getScriptSnapshotDecorator.name, () => {
 			const _abiHelloWorld = ["function greet() pure returns (string)"] as const;
 			const _nameHelloWorld = "HelloWorld" as const;
 			/**
-			 * HelloWorld Contract
+			 * HelloWorld 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 HelloWorld: Contract<typeof _nameHelloWorld, typeof _abiHelloWorld, undefined, undefined, undefined, undefined>;
 			const _abiHelloWorld2 = ["function greet2() pure returns (string)"] as const;
 			const _nameHelloWorld2 = "HelloWorld2" as const;
 			/**
-			 * HelloWorld2 Contract
+			 * HelloWorld2 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 HelloWorld2: Contract<typeof _nameHelloWorld2, typeof _abiHelloWorld2, undefined, undefined, undefined, undefined>;"
 		`)