CreateEVMOptions

CreateEVMOptions: object

Options for creating an Tevm MemoryClient instance

Type declaration

allowUnlimitedContractSize

allowUnlimitedContractSize?: boolean

Enable/disable unlimited contract size. Defaults to false.

customPrecompiles

customPrecompiles?: CustomPrecompile[]

Custom precompiles allow you to run arbitrary JavaScript code in the EVM. See the Precompile guide documentation for a deeper dive An ever growing standard library of precompiles is provided at tevm/precompiles

Notice

Not implemented yet Implementation pr

Below example shows how to make a precompile so you can call fs.writeFile and fs.readFile in your contracts. Note: this specific precompile is also provided in the standard library

For security precompiles can only be added statically when the vm is created.

Example

import { createMemoryClient, defineCall, definePrecompile } from 'tevm'
import { createScript } from '@tevm/contract'
import fs from 'fs/promises'

const Fs = createScript({
  name: 'Fs',
  humanReadableAbi: [
    'function readFile(string path) returns (string)',
    'function writeFile(string path, string data) returns (bool)',
  ]
})

const fsPrecompile = definePrecompile({
  contract: Fs,
  address: '0xf2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2f2',
  call: defineCall(Fs.abi, {
    readFile: async ({ args }) => {
      return {
        returnValue: await fs.readFile(...args, 'utf8'),
        executionGasUsed: 0n,
      }
    },
    writeFile: async ({ args }) => {
      await fs.writeFile(...args)
      return { returnValue: true, executionGasUsed: 0n }
    },
  }),
})

const tevm = createMemoryClient({ customPrecompiles: [fsPrecompile] })

### customPredeploys

> **customPredeploys**?: `ReadonlyArray`\<[`CustomPredeploy`](/reference/tevm/memory-client/type-aliases/custompredeploy/)\<`any`, `any`\>\>

Custom predeploys allow you to deploy arbitrary EVM bytecode to an address.
This is a convenience method and equivalent to calling tevm.setAccount() manually
to set the contract code.
```typescript
const tevm = createMemoryClient({
  customPredeploys: [
    // can pass a `tevm Script` here as well
    {
       address: '0x420420...',
       abi: [...],
       deployedBytecode: '0x420420...',
    }
  ],
})

eips

eips?: ReadonlyArray<number>

Eips to enable. Defaults to [1559, 4895]

fork

fork?: ForkStateManagerOpts

Fork options fork a live network if enabled. When in fork mode Tevm will fetch and cache all state from the block forked from the provided URL Cannot be set if proxy is also set

hardfork

hardfork?: Hardfork

Hardfork to use. Defaults to shanghai

profiler

profiler?: boolean

Enable profiler. Defaults to false.

proxy

proxy?: ProxyStateManagerOpts

Options to initialize the client in proxy mode When in proxy mode Tevm will fetch all state from the latest block of the provided proxy URL Cannot be set if fork is also set

Source

packages/memory-client/src/CreateEVMOptions.ts:31

---

Generated using typedoc-plugin-markdown and TypeDoc