✨ Feat(contract): Add address utility to contract (#828)

## Description

Add address utility and finalize the contract api

## 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:



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
  - Introduced `Script` as a new contract type with bytecode.
  - Added `withAddress` method to associate addresses with contracts.

- **Enhancements**
- Simplified contract creation process by removing the need for
`undefined` in optional parameters.

- **Refactor**
  - Renamed `TevmContract` to `Contract` across the application.
  - Updated contract creation function to `createContract` for clarity.
- Improved import handling in runtime generation based on module type
and bytecode inclusion.

- **Documentation**
  - Updated documentation to reflect renaming and new features.

- **Bug Fixes**
- Adjusted error messages and default contract name in TypeScript plugin
files for consistency.

- **Tests**
- Removed specific coverage configuration properties from
`vitest.config.ts`.
- Updated test suites to verify new contract and script creation
functionalities.

- **Style**
- Standardized the `Events` type definition for consistency with new
address handling.

- **Chores**
  - Cleaned up references and links in markdown documentation files.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Will Cory <[email protected]>

.changeset/neat-sloths-film.md

@@ -0,0 +1,31 @@
+---
+"@tevm/contract": major
+---
+
+- Changed name of `TevmContract` to `Contract` 
+- Changed name of `createTevmContract` to `createContract` 
+- Added `Script` to be a Contract with bytecode
+- Removed bytecode from `Contract`
+- Added a new `withAddress` method for adding an address to a contract
+- Removed need to explicitly pass in undefined for optional params
+
+## withAddress
+
+Before we had to spred contracts like this:
+
+```typescript
+client.readContract({
+  address: contractAddress,
+  ...Erc20Contract.read.balanceOf(userAddress)
+})
+```
+
+Now Tevm can create a contract with an address attatched
+
+
+```typescript
+client.readContract(
+  Erc20Contract.withAddress(contractAddress).read.balanceOf(userAddress)
+)
+```
+

bundler/base/TestContract.d.ts

@@ -1,4 +1,4 @@
-import { TevmContract } from '@tevm/contract'
+import { Contract } from '@tevm/contract'
 const _abiTestContract = [
 	{
 		constant: true,
@@ -119,10 +119,10 @@ const _abiTestContract = [
 const _chainAddressMapTestContract = { '10': '0x123' } as const
 const _nameTestContract = 'TestContract' as const
 /**
- * TestContract TevmContract
+ * TestContract Contract
  * @etherscan-10 https://optimistic.etherscan.io/address/0x123
  */
-export const TestContract: TevmContract<
+export const TestContract: Contract<
 	typeof _nameTestContract,
 	typeof _chainAddressMapTestContract,
 	typeof _abiTestContract

bundler/base/src/bundler.spec.ts

@@ -299,13 +299,13 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { TevmContract } from '@tevm/contract'
+				  "code": "import { Contract } from '@tevm/contract'
 				const _abiTestContract = [] as const;
 				const _nameTestContract = \\"TestContract\\" as const;
 				/**
-				 * TestContract TevmContract
+				 * TestContract Contract
 				 */
-				export const TestContract: TevmContract<typeof _nameTestContract, typeof _abiTestContract, undefined, undefined>;",
+				export const TestContract: Contract<typeof _nameTestContract, typeof _abiTestContract>;",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -384,13 +384,13 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { TevmContract } from '@tevm/contract'
+				  "code": "import { Contract } from '@tevm/contract'
 				const _abiTestContract = [] as const;
 				const _nameTestContract = \\"TestContract\\" as const;
 				/**
-				 * TestContract TevmContract
+				 * TestContract Contract
 				 */
-				export const TestContract: TevmContract<typeof _nameTestContract, typeof _abiTestContract, undefined, undefined>;",
+				export const TestContract: Contract<typeof _nameTestContract, typeof _abiTestContract>;",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -478,9 +478,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { createTevmContract } from '@tevm/contract'
+				  "code": "import { createContract } from '@tevm/contract'
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]} as const
-				export const TestContract = createTevmContract(_TestContract)",
+				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -568,9 +568,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { createTevmContract } from '@tevm/contract'
+				  "code": "import { createContract } from '@tevm/contract'
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]} as const
-				export const TestContract = createTevmContract(_TestContract)",
+				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -658,9 +658,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "const { createTevmContract } = require('@tevm/contract')
+				  "code": "const { createContract } = require('@tevm/contract')
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]}
-				module.exports.TestContract = createTevmContract(_TestContract)",
+				module.exports.TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -748,9 +748,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "const { createTevmContract } = require('@tevm/contract')
+				  "code": "const { createContract } = require('@tevm/contract')
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]}
-				module.exports.TestContract = createTevmContract(_TestContract)",
+				module.exports.TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -838,9 +838,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { createTevmContract } from '@tevm/contract'
+				  "code": "import { createContract } from '@tevm/contract'
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]}
-				export const TestContract = createTevmContract(_TestContract)",
+				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'
@@ -928,9 +928,9 @@ describe(bundler.name, () => {
 				      "evmVersion": "homestead",
 				    },
 				  },
-				  "code": "import { createTevmContract } from '@tevm/contract'
+				  "code": "import { createContract } from '@tevm/contract'
 				const _TestContract = {\\"name\\":\\"TestContract\\",\\"humanReadableAbi\\":[]}
-				export const TestContract = createTevmContract(_TestContract)",
+				export const TestContract = createContract(_TestContract)",
 				  "modules": {
 				    "module1": {
 				      "code": "import { TestContract } from 'module2'

bundler/bun/docs/modules.md

@@ -6,13 +6,13 @@
 
 ### Functions
 
-- [tevmBunPlugin](undefined)
+- [tevmBunPlugin](modules.md#tevmbunplugin)
 
 ## Functions
 
 ### tevmBunPlugin
 
-▸ **tevmBunPlugin**(`SolcVersions`): BunPlugin
+▸ **tevmBunPlugin**(`SolcVersions`): `BunPlugin`
 
 @tevm/bun-plugin is a bun plugin that allows you to import solidity files into your typescript files
 and have them compiled to typescript on the fly.
@@ -21,12 +21,12 @@ and have them compiled to typescript on the fly.
 
 | Name | Type |
 | :------ | :------ |
-| `SolcVersions` | Object |
-| `SolcVersions.solc?` | SolcVersions$1 |
+| `SolcVersions` | `Object` |
+| `SolcVersions.solc?` | `SolcVersions$1` |
 
 #### Returns
 
-BunPlugin
+`BunPlugin`
 
 **`Example`**
 

bundler/bundler-cache/TestContract.d.ts

@@ -1,4 +1,4 @@
-import { TevmContract } from '@tevm/contract'
+import { Contract } from '@tevm/contract'
 const _abiTestContract = [
 	{
 		constant: true,
@@ -119,10 +119,10 @@ const _abiTestContract = [
 const _chainAddressMapTestContract = { '10': '0x123' } as const
 const _nameTestContract = 'TestContract' as const
 /**
- * TestContract TevmContract
+ * TestContract Contract
  * @etherscan-10 https://optimistic.etherscan.io/address/0x123
  */
-export const TestContract: TevmContract<
+export const TestContract: Contract<
 	typeof _nameTestContract,
 	typeof _chainAddressMapTestContract,
 	typeof _abiTestContract

bundler/compiler/TestContract.d.ts

@@ -1,4 +1,4 @@
-import { TevmContract } from '@tevm/contract'
+import { Contract } from '@tevm/contract'
 const _abiTestContract = [
 	{
 		constant: true,
@@ -119,10 +119,10 @@ const _abiTestContract = [
 const _chainAddressMapTestContract = { '10': '0x123' } as const
 const _nameTestContract = 'TestContract' as const
 /**
- * TestContract TevmContract
+ * TestContract Contract
  * @etherscan-10 https://optimistic.etherscan.io/address/0x123
  */
-export const TestContract: TevmContract<
+export const TestContract: Contract<
 	typeof _nameTestContract,
 	typeof _chainAddressMapTestContract,
 	typeof _abiTestContract

bundler/resolutions/TestContract.d.ts

@@ -1,4 +1,4 @@
-import { TevmContract } from '@tevm/contract'
+import { Contract } from '@tevm/contract'
 const _abiTestContract = [
 	{
 		constant: true,
@@ -119,10 +119,10 @@ const _abiTestContract = [
 const _chainAddressMapTestContract = { '10': '0x123' } as const
 const _nameTestContract = 'TestContract' as const
 /**
- * TestContract TevmContract
+ * TestContract Contract
  * @etherscan-10 https://optimistic.etherscan.io/address/0x123
  */
-export const TestContract: TevmContract<
+export const TestContract: Contract<
 	typeof _nameTestContract,
 	typeof _chainAddressMapTestContract,
 	typeof _abiTestContract

bundler/runtime/docs/modules.md

@@ -6,17 +6,17 @@
 
 ### Type Aliases
 
-- [ModuleType](undefined)
+- [ModuleType](modules.md#moduletype)
 
 ### Functions
 
-- [generateRuntime](undefined)
+- [generateRuntime](modules.md#generateruntime)
 
 ## Type Aliases
 
 ### ModuleType
 
-Ƭ **ModuleType**: "cjs" \| "dts" \| "ts" \| "mjs"
+Ƭ **ModuleType**: ``"cjs"`` \| ``"dts"`` \| ``"ts"`` \| ``"mjs"``
 
 #### Defined in
 
@@ -26,20 +26,20 @@
 
 ### generateRuntime
 
-▸ **generateRuntime**(`artifacts`, `moduleType`, `includeBytecode`): Effect\<never, never, string\>
+▸ **generateRuntime**(`artifacts`, `moduleType`, `includeBytecode`): `Effect`\<`never`, `never`, `string`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `artifacts` | Artifacts$1 |
-| `moduleType` | ModuleType |
-| `includeBytecode` | boolean |
+| `artifacts` | `Artifacts$1` |
+| `moduleType` | [`ModuleType`](modules.md#moduletype) |
+| `includeBytecode` | `boolean` |
 
 #### Returns
 
-Effect\<never, never, string\>
+`Effect`\<`never`, `never`, `string`\>
 
 #### Defined in
 
-[generateRuntime.js:17](https://github.com/evmts/tevm-monorepo/blob/main/bundler/runtime/src/generateRuntime.js#L17)
+[generateRuntime.js:25](https://github.com/evmts/tevm-monorepo/blob/main/bundler/runtime/src/generateRuntime.js#L25)

bundler/runtime/src/generateRuntime.js

@@ -2,10 +2,18 @@ import { generateTevmBody } from './generateTevmBody.js'
 import { die, map } from 'effect/Effect'
 
 const importsByModuleType = {
-	cjs: `const { createTevmContract } = require('@tevm/contract')`,
-	dts: `import { TevmContract } from '@tevm/contract'`,
-	ts: `import { createTevmContract } from '@tevm/contract'`,
-	mjs: `import { createTevmContract } from '@tevm/contract'`,
+	contract: {
+		cjs: `const { createContract } = require('@tevm/contract')`,
+		dts: `import { Contract } from '@tevm/contract'`,
+		ts: `import { createContract } from '@tevm/contract'`,
+		mjs: `import { createContract } from '@tevm/contract'`,
+	},
+	script: {
+		cjs: `const { createScript } = require('@tevm/contract')`,
+		dts: `import { Script } from '@tevm/contract'`,
+		ts: `import { createScript } from '@tevm/contract'`,
+		mjs: `import { createScript } from '@tevm/contract'`,
+	},
 }
 
 /**
@@ -18,7 +26,8 @@ export const generateRuntime = (artifacts, moduleType, includeBytecode) => {
 	if (!artifacts || Object.keys(artifacts).length === 0) {
 		return die('No artifacts provided to generateRuntime')
 	}
-	const imports = importsByModuleType[moduleType]
+	const imports =
+		importsByModuleType[includeBytecode ? 'script' : 'contract'][moduleType]
 	if (!imports) {
 		return die(
 			`Unknown module type: ${moduleType}. Valid module types include ${Object.keys(

bundler/runtime/src/generateRuntime.spec.ts

@@ -25,7 +25,7 @@ describe('generateRuntime', () => {
 		expect(() =>
 			runSync(generateRuntime(artifacts, 'invalidType' as any, false)),
 		).toThrowErrorMatchingInlineSnapshot(
-			'"Unknown module type: invalidType. Valid module types include cjs, dts, ts, mjs"',
+			'"Unknown module type: invalidType. Valid module types include contract, script"',
 		)
 	})
 
@@ -48,54 +48,54 @@ describe('generateRuntime', () => {
 	it('should handle commonjs module type', () => {
 		const result = runSync(generateRuntime(artifacts, 'cjs', false))
 		expect(result).toMatchInlineSnapshot(`
-			"const { createTevmContract } = require('@tevm/contract')
+			"const { createContract } = require('@tevm/contract')
 			const _MyContract = {\\"name\\":\\"MyContract\\",\\"humanReadableAbi\\":[\\"constructor() payable\\"]}
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
-			module.exports.MyContract = createTevmContract(_MyContract)"
+			module.exports.MyContract = createContract(_MyContract)"
 		`)
 	})
 
 	it('should handle dts module type', () => {
 		const result = runSync(generateRuntime(artifacts, 'dts', false))
 		expect(result).toMatchInlineSnapshot(`
-			"import { TevmContract } from '@tevm/contract'
+			"import { Contract } from '@tevm/contract'
 			const _abiMyContract = [\\"constructor() payable\\"] as const;
 			const _nameMyContract = \\"MyContract\\" as const;
 			/**
-			 * MyContract TevmContract
+			 * MyContract Contract
 			 * @notice MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
-			export const MyContract: TevmContract<typeof _nameMyContract, typeof _abiMyContract, undefined, undefined>;"
+			export const MyContract: Contract<typeof _nameMyContract, typeof _abiMyContract>;"
 		`)
 	})
 
 	it('should handle ts module type', () => {
 		const result = runSync(generateRuntime(artifacts, 'ts', false))
 		expect(result).toMatchInlineSnapshot(`
-			"import { createTevmContract } from '@tevm/contract'
+			"import { createContract } from '@tevm/contract'
 			const _MyContract = {\\"name\\":\\"MyContract\\",\\"humanReadableAbi\\":[\\"constructor() payable\\"]} as const
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
-			export const MyContract = createTevmContract(_MyContract)"
+			export const MyContract = createContract(_MyContract)"
 		`)
 	})
 
 	it('should handle mjs module type', () => {
 		const result = runSync(generateRuntime(artifacts, 'mjs', false))
 		expect(result).toMatchInlineSnapshot(`
-			"import { createTevmContract } from '@tevm/contract'
+			"import { createContract } from '@tevm/contract'
 			const _MyContract = {\\"name\\":\\"MyContract\\",\\"humanReadableAbi\\":[\\"constructor() payable\\"]}
 			/**
 			 * MyContract
 			 * @property balanceOf(address) Returns the amount of tokens owned by account
 			 */
-			export const MyContract = createTevmContract(_MyContract)"
+			export const MyContract = createContract(_MyContract)"
 		`)
 	})
 })